ExternalVendorCode/pandoc-latex-template
1
0
Fork 0
mirror of https://github.com/Wandmalfarbe/pandoc-latex-template.git synced 2024-12-24 08:26:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Changed README formatting.

Browse Source
This commit is contained in:
Wandmalfarbe 2019-09-22 14:43:55 +02:00
parent e475fc8cef
commit c97a5aebe3
1 changed files with 97 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -8,9 +8,9 @@ A clean **pandoc LaTeX template** to convert your markdown files to PDF or LaTeX
## Preview
A custom title page | A basic example page
:-------------------------:|:-------------------------:
[![A custom title page](examples/custom-titlepage/custom-titlepage.png)](examples/custom-titlepage/custom-titlepage.pdf) | [![A basic example page](examples/basic-example/basic-example.png)](examples/basic-example/basic-example.pdf)
| A custom title page | A basic example page |
| :------------------: | :------------------: |
| [![A custom title page](examples/custom-titlepage/custom-titlepage.png)](examples/custom-titlepage/custom-titlepage.pdf) | [![A basic example page](examples/basic-example/basic-example.png)](examples/basic-example/basic-example.pdf) |
## Installation
@ -21,12 +21,12 @@ A custom title page | A basic example page
- Unix, Linux, macOS: `$XDG_DATA_HOME/pandoc/templates` or `~/.pandoc/templates/`
- Windows XP: `C:\Documents And Settings\USERNAME\Application Data\pandoc\templates`
- Windows Vista or later: `C:\Users\USERNAME\AppData\Roaming\pandoc\templates`
If there are no folders called `templates` or `pandoc` you need to create them and put the template `eisvogel.latex` inside.
## Usage
1. Open the terminal and navigate to the folder where your markdown file is located.
2. Execute the following command
``` bash
@ -55,60 +55,79 @@ This template defines some new variables to control the appearance of the result
- `titlepage` (defaults to `false`)
turns on the title page when `true`
- `titlepage-color`
the background color of the title page. The color value must be given as an HTML hex color like `D8DE2C` without the leading number sign (`#`). When specifying the color in YAML, it is advisable to enclose it in quotes like so `titlepage-color: "D8DE2C"` to avoid the truncation of the color (e.g. `000000` becoming `0`).
the background color of the title page. The color value must be given as an HTML hex color like `D8DE2C` without the leading number sign (`#`). When specifying the color in YAML, it is advisable to enclose it in quotes like so `titlepage-color: "D8DE2C"` to avoid the truncation of the color (e.g. `000000` becoming `0`).
- `titlepage-text-color` (defaults to `5F5F5F`)
the text color of the title page
- `titlepage-rule-color` (defaults to `435488`)
the color of the rule on the top of the title page
- `titlepage-rule-height` (defaults to `4`)
the height of the rule on the top of the title page (in points)
- `titlepage-background`
the path to a background image for the title page. The background image is scaled to cover the entire page. In the examples folder under `titlepage-background` are a few example background images.
- `caption-justification` (defaults to `raggedright`)
justification setting for captions (uses the `justification` parameter of the [caption](https://ctan.org/pkg/caption?lang=en) package)
- `toc-own-page` (defaults to `false`)
begin new page after table of contents, when `true`
- `listings-disable-line-numbers` (defaults to `false`)
disables line numbers for all listings
- `listings-no-page-break` (defaults to `false`)
avoid page break inside listings
- `disable-header-and-footer` (default to `false`)
disables the header and footer completely on all pages
- `header-left` (defaults to the title)
the text on the left side of the header
- `header-center`
the text in the center of the header
- `header-right` (defaults to the date)
the text on the right side of the header
- `footer-left` (defaults to the author)
the text on the left side of the footer
- `footer-center`
the text in the center of the footer
- `footer-right` (defaults to the page number)
the text on the right side of the footer
- `book` (defaults to `false`)
typeset as book
- `logo`
path to an image that will be displayed on the title page. The path is always relative to where pandoc is executed. The option `--resource-path` has no effect.
- `logo-width` (defaults to `100`)
the width of the logo (in points)
@ -119,7 +138,7 @@ This template defines some new variables to control the appearance of the result
- `float-placement-figure` (defaults to `H`)
Reset the default placement specifier for figure environments to the supplied value e.g. `htbp`. The available specifiers are listed below. The first four placement specifiers can be combined.
Reset the default placement specifier for figure environments to the supplied value e.g. `htbp`. The available specifiers are listed below. The first four placement specifiers can be combined.
1. `h`: Place the float *here*, i.e., approximately at the same point it occurs in the source text.
2. `t`: Place the float at the *top* of the page.
@ -144,6 +163,7 @@ You can get syntax highlighting of delimited code blocks by using the LaTeX pack
``` bash
pandoc example.md -o example.pdf --template eisvogel --listings
```
### Syntax Highlighting Without Listings
The following examples show [syntax highlighting of delimited code blocks](http://pandoc.org/MANUAL.html#syntax-highlighting) without using listings. To see a list of all the supported highlight styles, type `pandoc --list-highlight-styles`.
@ -174,7 +194,7 @@ pandoc example.md -o example.tex --template eisvogel
### Changing the Document Language
The default language of this template is American English. The `lang` variable identifies the main language of the document, using a code according to [BCP 47](https://tools.ietf.org/html/bcp47) (e.g. `en` or `en-GB`). For an incomplete list of the supported language codes see [the documentation for the hyph-utf8 package (Section 2)](http://mirrors.ctan.org/language/hyph-utf8/doc/generic/hyph-utf8/hyph-utf8.pdf). The following example changes the language to British English:
The default language of this template is American English. The `lang` variable identifies the main language of the document, using a code according to [BCP 47](https://tools.ietf.org/html/bcp47) (e.g. `en` or `en-GB`). For an incomplete list of the supported language codes see [the documentation for the hyph-utf8 package (Section 2)](http://mirrors.ctan.org/language/hyph-utf8/doc/generic/hyph-utf8/hyph-utf8.pdf). The following example changes the language to British English:
``` bash
pandoc example.md -o example.pdf --template eisvogel -V lang=en-GB
@ -192,21 +212,21 @@ To typeset a book supply the template variable `-V book` from the command line o
To get the correct chapter headings you need to tell pandoc that it should convert first level headings (indicated by one `#` in markdown) to chapters with the command line option `--top-level-division=chapter`. Chapter numbers start at 1. If you need to change that, specify `first-chapter` in the template variables.
There will be one blank page before each chapter because the template is two-sided per default. So if you plan to publish your book as a PDF and don't need a blank page you should add the class option `onesided` which can be done by supplying a template variable `-V classoption=oneside`.
There will be one blank page before each chapter because the template is two-sided per default. So if you plan to publish your book as a PDF and don’t need a blank page you should add the class option `onesided` which can be done by supplying a template variable `-V classoption=oneside`.
### Example Images
A green title page | A background image on the title page
:-------------------------:|:-------------------------:
[![A green title page](examples/green-titlepage/green-titlepage.png)](examples/green-titlepage/green-titlepage.pdf) | [![A background image on the title page](examples/titlepage-background/titlepage-background.png)](examples/titlepage-background/titlepage-background.pdf)
| A green title page | A background image on the title page |
| :----------------: | :----------------: |
| [![A green title page](examples/green-titlepage/green-titlepage.png)](examples/green-titlepage/green-titlepage.pdf) | [![A background image on the title page](examples/titlepage-background/titlepage-background.png)](examples/titlepage-background/titlepage-background.pdf) |
images and tables | Code blocks styled without listings
:-------------------------:|:-------------------------:
[![images and tables](examples/images-and-tables/images-and-tables.png)](examples/images-and-tables/images-and-tables.pdf) | [![Code blocks styled without listings](examples/without-listings/without-listings.png)](examples/without-listings/without-listings.pdf)
| images and tables | Code blocks styled without listings |
| :---------------: | :---------------: |
| [![images and tables](examples/images-and-tables/images-and-tables.png)](examples/images-and-tables/images-and-tables.pdf) | [![Code blocks styled without listings](examples/without-listings/without-listings.png)](examples/without-listings/without-listings.pdf) |
A book | Code blocks styled with listings
:-------------------------:|:-------------------------:
[![A book](examples/book/book.png)](examples/book/book.pdf) | [![Code blocks styled with listings](examples/listings/listings.png)](examples/listings/listings.pdf)
| A book | Code blocks styled with listings |
| :----: | :----: |
| [![A book](examples/book/book.png)](examples/book/book.pdf) | [![Code blocks styled with listings](examples/listings/listings.png)](examples/listings/listings.pdf) |
## Credits