Beruflich Dokumente
Kultur Dokumente
buildpassing
A clean pandoc LaTeX template to convert your markdown files to PDF or LaTeX. It is
designed for lecture notes and exercises with a focus on computer science. The template is
compatible with pandoc 2.
Preview
1
A custom title page
2
A custom title page
Installation
Usage
1. Open the terminal and navigate to the folder where your markdown file is located.
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 at the top of your markdown document (see the
example markdown file). Your markdown document may look like the following:
---
title: "The Document Title"
author: [Example Author, Another Author]
date: "2017-02-20"
keywords: [Markdown, Example]
...
This template defines some new variables to control the appearance of the title page. The existing
template variables from pandoc are all supported and their documentation can be found in the
3
pandoc manual.
• 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).
• titlepage-rule-height (defaults to 4)
the height of the rule on the top of the title page (in points)
justification setting for captions (uses the justification parameter of the caption package)
• header-center
4
• footer-left (defaults to the author)
• footer-center
Examples
Numbered Sections
You can get syntax highlighting of delimited code blocks by using the LaTeX package listings
with the option --listings. This example will produce the same syntax highlighting as in the
example PDF.
The following examples show syntax highlighting of delimited code blocks without using listings.
To see a list of all the supported highlight styles, type pandoc --list-highlight-styles.
To produce a standalone LaTeX document for compiling with any LaTeX editor use .tex as an
output file extension.
5
pandoc example.md -o example.tex --template eisvogel
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 (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). The following example changes the language to British English:
Typesetting a Book
The template uses the default KOMA-Script class scrartcl as the document class because
it has some advantages over the default article class. For typesetting a book I recommend
the corresponding KOMA-Script class scrbook instead of the default book. You can manually
replace the string scrartcl in the template with scrbook.
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.
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
6
A green title page
7
A green title page
8
images and tables
9
images and tables
Credits
• This template includes code for styling block quotations from pandoc-letter by Aaron
Wolen.
License
This project is open source licensed under the BSD 3-Clause License. Please see the LICENSE
file for more information.
10