mirror of
https://github.com/Wandmalfarbe/pandoc-latex-template.git
synced 2025-01-30 08:03:51 +00:00
Fix typos and convert links to HTTPS (#400)
- This PR fixes typos I spotted in the project. - It also converts a few links from HTTP to HTTPS protocol.
This commit is contained in:
parent
23a92c3b3b
commit
d522827383
2
.github/workflows/build-examples.yml
vendored
2
.github/workflows/build-examples.yml
vendored
@ -16,7 +16,7 @@ jobs:
|
|||||||
wget -qO- https://github.com/jgm/pandoc/releases/download/${PANDOC_VERSION}/pandoc-${PANDOC_VERSION}-linux-amd64.tar.gz | sudo tar xzf - --strip-components 1 -C /usr/local/
|
wget -qO- https://github.com/jgm/pandoc/releases/download/${PANDOC_VERSION}/pandoc-${PANDOC_VERSION}-linux-amd64.tar.gz | sudo tar xzf - --strip-components 1 -C /usr/local/
|
||||||
- name: Setup TexLive
|
- name: Setup TexLive
|
||||||
env:
|
env:
|
||||||
REMOTE: http://mirror.ctan.org/systems/texlive/tlnet
|
REMOTE: https://mirror.ctan.org/systems/texlive/tlnet
|
||||||
INSTALL: '/tmp/install-texlive'
|
INSTALL: '/tmp/install-texlive'
|
||||||
run: |
|
run: |
|
||||||
mkdir -p ${INSTALL}
|
mkdir -p ${INSTALL}
|
||||||
|
16
README.md
16
README.md
@ -12,7 +12,7 @@ A clean **pandoc LaTeX template** to convert your markdown files to PDF or LaTeX
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
1. Install pandoc from <http://pandoc.org/>. You also need to install [LaTeX](https://en.wikibooks.org/wiki/LaTeX/Installation#Distributions).
|
1. Install pandoc from <https://pandoc.org/>. You also need to install [LaTeX](https://en.wikibooks.org/wiki/LaTeX/Installation#Distributions).
|
||||||
2. Download the latest version of the Eisvogel template from [the release page](https://github.com/Wandmalfarbe/pandoc-latex-template/releases/latest).
|
2. Download the latest version of the Eisvogel template from [the release page](https://github.com/Wandmalfarbe/pandoc-latex-template/releases/latest).
|
||||||
3. Extract the downloaded ZIP archive and open the folder.
|
3. Extract the downloaded ZIP archive and open the folder.
|
||||||
4. Move the two template files `eisvogel.latex` and `eisvogel.beamer` to your
|
4. Move the two template files `eisvogel.latex` and `eisvogel.beamer` to your
|
||||||
@ -86,7 +86,7 @@ pandock example.md -o example.pdf --template eisvogel --listings
|
|||||||
|
|
||||||
where `example.md` is the markdown file you want to convert to PDF.
|
where `example.md` is the markdown file you want to convert to PDF.
|
||||||
|
|
||||||
In order to have nice headers and footers you need to supply metadata to your document. You can do that with a [YAML metadata block](http://pandoc.org/MANUAL.html#extension-yaml_metadata_block) at the top of your markdown document (see the [example markdown file](examples/basic-example/document.md)). Your markdown document may look like the following:
|
In order to have nice headers and footers you need to supply metadata to your document. You can do that with a [YAML metadata block](https://pandoc.org/MANUAL.html#extension-yaml_metadata_block) at the top of your markdown document (see the [example markdown file](examples/basic-example/document.md)). Your markdown document may look like the following:
|
||||||
|
|
||||||
``` markdown
|
``` markdown
|
||||||
---
|
---
|
||||||
@ -208,7 +208,7 @@ This template defines some new variables to control the appearance of the result
|
|||||||
- `dd`: Didot point
|
- `dd`: Didot point
|
||||||
- `cc`: cicero (12 `dd`)
|
- `cc`: cicero (12 `dd`)
|
||||||
- `sp`: Scaled point (65,536 `sp` = 1 `pt`)
|
- `sp`: Scaled point (65,536 `sp` = 1 `pt`)
|
||||||
- `ex`: Nomimal x-height
|
- `ex`: Nominal x-height
|
||||||
- `em`: Nominal m-width
|
- `em`: Nominal m-width
|
||||||
- `px`: Pixel (only for pdfTeX and LuaTeX) The dimension given to the `\pdfpxdimen` primitive; default value is 1 `bp`, corresponding to a pixel density of 72 dpi.
|
- `px`: Pixel (only for pdfTeX and LuaTeX) The dimension given to the `\pdfpxdimen` primitive; default value is 1 `bp`, corresponding to a pixel density of 72 dpi.
|
||||||
|
|
||||||
@ -302,7 +302,7 @@ an alternative](https://miktex.org/howto/miktex-console).
|
|||||||
|
|
||||||
### Numbered Sections
|
### Numbered Sections
|
||||||
|
|
||||||
For PDFs with [numbered sections](http://pandoc.org/MANUAL.html#options-affecting-specific-writers) use the `--number-sections` or `-N` option.
|
For PDFs with [numbered sections](https://pandoc.org/MANUAL.html#options-affecting-specific-writers) use the `--number-sections` or `-N` option.
|
||||||
|
|
||||||
``` bash
|
``` bash
|
||||||
pandoc example.md -o example.pdf --template eisvogel --number-sections
|
pandoc example.md -o example.pdf --template eisvogel --number-sections
|
||||||
@ -318,7 +318,7 @@ pandoc example.md -o example.pdf --template eisvogel --listings
|
|||||||
|
|
||||||
### Syntax Highlighting Without 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`.
|
The following examples show [syntax highlighting of delimited code blocks](https://pandoc.org/MANUAL.html#syntax-highlighting) without using listings. To see a list of all the supported highlight styles, type `pandoc --list-highlight-styles`.
|
||||||
|
|
||||||
``` bash
|
``` bash
|
||||||
pandoc example.md -o example.pdf --template eisvogel --highlight-style pygments
|
pandoc example.md -o example.pdf --template eisvogel --highlight-style pygments
|
||||||
@ -346,7 +346,7 @@ pandoc example.md -o example.tex --template eisvogel
|
|||||||
|
|
||||||
### Changing the Document Language
|
### 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)](https://mirrors.ctan.org/language/hyph-utf8/doc/generic/hyph-utf8/hyph-utf8.pdf). The following example changes the language to British English:
|
||||||
|
|
||||||
``` bash
|
``` bash
|
||||||
pandoc example.md -o example.pdf --template eisvogel -V lang=en-GB
|
pandoc example.md -o example.pdf --template eisvogel -V lang=en-GB
|
||||||
@ -400,8 +400,8 @@ Error producing PDF.
|
|||||||
|
|
||||||
``` latex
|
``` latex
|
||||||
Error producing PDF.
|
Error producing PDF.
|
||||||
! Package pdftex.def Error: File `logo\T1\textunderscoreimage.pdf' not fou
|
! Package pdftex.def Error: File `logo\T1\textunderscoreimage.pdf' not found:
|
||||||
nd: using draft setting.
|
using draft setting.
|
||||||
|
|
||||||
See the pdftex.def package documentation for explanation.
|
See the pdftex.def package documentation for explanation.
|
||||||
Type H <return> for immediate help.
|
Type H <return> for immediate help.
|
||||||
|
@ -12,7 +12,7 @@ A clean **pandoc LaTeX template** to convert your markdown files to PDF or LaTeX
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
1. Install pandoc from <http://pandoc.org/>. You also need to install [LaTeX](https://en.wikibooks.org/wiki/LaTeX/Installation#Distributions).
|
1. Install pandoc from <https://pandoc.org/>. You also need to install [LaTeX](https://en.wikibooks.org/wiki/LaTeX/Installation#Distributions).
|
||||||
2. Download the latest version of the Eisvogel template from [the release page](https://github.com/Wandmalfarbe/pandoc-latex-template/releases/latest).
|
2. Download the latest version of the Eisvogel template from [the release page](https://github.com/Wandmalfarbe/pandoc-latex-template/releases/latest).
|
||||||
3. Extract the downloaded ZIP archive and open the folder.
|
3. Extract the downloaded ZIP archive and open the folder.
|
||||||
4. Move the template `eisvogel.tex` to your pandoc templates folder and rename the file to `eisvogel.latex`. The location of the templates folder depends on your operating system:
|
4. Move the template `eisvogel.tex` to your pandoc templates folder and rename the file to `eisvogel.latex`. The location of the templates folder depends on your operating system:
|
||||||
@ -33,7 +33,7 @@ A clean **pandoc LaTeX template** to convert your markdown files to PDF or LaTeX
|
|||||||
|
|
||||||
where `example.md` is the markdown file you want to convert to PDF.
|
where `example.md` is the markdown file you want to convert to PDF.
|
||||||
|
|
||||||
In order to have nice headers and footers you need to supply metadata to your document. You can do that with a [YAML metadata block](http://pandoc.org/MANUAL.html#extension-yaml_metadata_block) at the top of your markdown document (see the [example markdown file](../examples/basic-example/basic-example.md)). Your markdown document may look like the following:
|
In order to have nice headers and footers you need to supply metadata to your document. You can do that with a [YAML metadata block](https://pandoc.org/MANUAL.html#extension-yaml_metadata_block) at the top of your markdown document (see the [example markdown file](../examples/basic-example/basic-example.md)). Your markdown document may look like the following:
|
||||||
|
|
||||||
``` markdown
|
``` markdown
|
||||||
---
|
---
|
||||||
@ -234,7 +234,7 @@ an alternative](https://miktex.org/howto/miktex-console).
|
|||||||
|
|
||||||
### Numbered Sections
|
### Numbered Sections
|
||||||
|
|
||||||
For PDFs with [numbered sections](http://pandoc.org/MANUAL.html#options-affecting-specific-writers) use the `--number-sections` or `-N` option.
|
For PDFs with [numbered sections](https://pandoc.org/MANUAL.html#options-affecting-specific-writers) use the `--number-sections` or `-N` option.
|
||||||
|
|
||||||
``` bash
|
``` bash
|
||||||
pandoc example.md -o example.pdf --template eisvogel --number-sections
|
pandoc example.md -o example.pdf --template eisvogel --number-sections
|
||||||
@ -250,7 +250,7 @@ pandoc example.md -o example.pdf --template eisvogel --listings
|
|||||||
|
|
||||||
### Syntax Highlighting Without 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`.
|
The following examples show [syntax highlighting of delimited code blocks](https://pandoc.org/MANUAL.html#syntax-highlighting) without using listings. To see a list of all the supported highlight styles, type `pandoc --list-highlight-styles`.
|
||||||
|
|
||||||
``` bash
|
``` bash
|
||||||
pandoc example.md -o example.pdf --template eisvogel --highlight-style pygments
|
pandoc example.md -o example.pdf --template eisvogel --highlight-style pygments
|
||||||
@ -278,7 +278,7 @@ pandoc example.md -o example.tex --template eisvogel
|
|||||||
|
|
||||||
### Changing the Document Language
|
### 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)](https://mirrors.ctan.org/language/hyph-utf8/doc/generic/hyph-utf8/hyph-utf8.pdf). The following example changes the language to British English:
|
||||||
|
|
||||||
``` bash
|
``` bash
|
||||||
pandoc example.md -o example.pdf --template eisvogel -V lang=en-GB
|
pandoc example.md -o example.pdf --template eisvogel -V lang=en-GB
|
||||||
@ -332,8 +332,8 @@ Error producing PDF.
|
|||||||
|
|
||||||
``` latex
|
``` latex
|
||||||
Error producing PDF.
|
Error producing PDF.
|
||||||
! Package pdftex.def Error: File `logo\T1\textunderscoreimage.pdf' not fou
|
! Package pdftex.def Error: File `logo\T1\textunderscoreimage.pdf' not found:
|
||||||
nd: using draft setting.
|
using draft setting.
|
||||||
|
|
||||||
See the pdftex.def package documentation for explanation.
|
See the pdftex.def package documentation for explanation.
|
||||||
Type H <return> for immediate help.
|
Type H <return> for immediate help.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user