Bergfink

A template for Pandoc to generate PDFs with Typst. This template is based on the Eisvogel template.

Preview

Custom title page	Basic example page

Installation

Download the template from /cmd/template and filters from /cmd/filters. Adjust the config.typ to your liking.

Manual Installation

1. Download md2pdf from /cmd/md2pdf and save it to `~/.local/bin
2. Download all files in /cmd/template to ~/.local/share/md2pdf/templates
3. Download all files in /cmd/filters to ~/.local/share/md2pdf/filters

Install Script (Linux)

curl https://raw.githubusercontent.com/andyburri/pandoc-typst-template/refs/heads/main/install.sh | bash

This does the following:

• Downloads md2pdf from /cmd/md2pdf and saves it as ~/.local/bin/md2pdf
• Downloads the filters from /cmd/filters and saves them as ~/.local/share/md2pdf/filters
• Downloads the templates from /cmd/template and saves them as ~/.local/share/md2pdf/templates

Configuration

Adjust the config.typ as you like. You can find more information about the configuration in /cmd/template/config.exmaple.typ.

Usage

Use the template with pandoc like this:

pandoc input_file.md -o output_file.pdf --pdf-engine=typst \
 --template="bergfink.typst" \
 -L "filters/include-files.lua" \
 -L "filters/diagram.lua" \
 -L "filters/typst-filters.lua"

or use the md2pdf bash script from /cmd/md2pdf

Included Lua Filters

Diagrams

Renders diagrams using Mermaid, PlantUML or Pikchr. You need to have mmdc, plantuml and pikchr-cli in your PATH to use them.

Include Files

Includes files from a directory into your document. You can use it like this:

```{.include shift-heading-level-by=n}
another-file.md
```

Typst Filters

This does the following:

• Stops pandoc from parsing Typst references (<ref> and @ref)
• Detects trailing <refs> in paragraphs and preserves them as Typst references
• Replaces <br> with pandoc.LineBreak(). Useful for breaking lines inside markdown tables.
• Parses align attributes in tables and images, and aligns them in Typst accordingly.
• Parses a caption attribute in code blocks and adds a Typst caption to them.
• Adds gfm-style alerts.

Template Variables

These variables can be set in the configuration, the metadata or the markdown frontmatter.

Setting	Default Value	Description
date	datetime.today()	The date shown in the header and title page.
dateformat	"[year]-[month]-[day]"	The date format used in the header and title page.
lang	"en"	Sets the language of the document.
region	"US"	Sets the regional format (e.g., for dates, numbers).
paper	"a4"	Sets the paper size.
font	("noto sans", "arial")	Sets the main font family.
heading-font	Same as font	Sets the font family for headings.
code-font	("noto mono", "courier")	Sets the font family for code.
fontsize	11pt	Sets the main font size.
leading	0.65em	Sets the paragraph line spacing.
spacing	1.2em	Sets the spacing between paragraph.
justify	true	Justifies paragraph text unless no-justify is set.
no-justify	false	Disables text justification when set to true.
margin	(x: 2.5cm, y: 3.5cm)	Sets page margins.
disable-header-and-footer	false	Removes header and footer when true.
header-and-footer-stroke	1pt + black	Sets the header and footer stroke.
page-numbering	"1"	Sets the page numbering style (e.g., "1", "1 / n").
authors	((name: "", email: "", affiliation: ""),)	List of authors with their info.
author	same as authors	Alternate author definition input.
title	none	The document title.
subtitle	none	The document subtitle.
supervisor	""	The supervisor’s name.
keywords	""	Document keywords (comma-separated).
titlepage	false	Enables title page when true.
titlepage-rule	2.5pt + black	Sets the title page rule style.
titlepage-bg	white	Sets the background color for the title page.
titlepage-fg	black	Sets the foreground color for the title page.
titlepage-logo	none	If set, the image at the path is shown on the bottom right.
titlepage-logo-width	12em	Sets the title page logo width.
toc	false	Inserts a table of contents.
toc-depth	none	Sets table of contents depth.
toc-own-page	false	Places the TOC on its own page when true.
lof	false	Inserts a list of figures.
lof-title	"List of Figures"	Title for the list of figures.
lot	false	Inserts a list of tables.
lot-title	"List of Tables"	Title for the list of tables.
listings	false	Enables styled code blocks with line numbers.
columns	1	Sets the number of text columns.
number-sections	false	Enables numbered section headings.
section-numbering	"1.1.1.1.1"	Defines section numbering style.
figure-prefix	"Fig."	Prefix label for figures.
table-prefix	"Table"	Prefix label for tables.
listing-prefix	"Listing"	Prefix label for code listings.
header-left	cfg.at("title", default: none)	Left-aligned header content (default is title).
header-center	none	Centered header content.
header-right	cfg.at("date", default: datetime.today())	Right-aligned header content (default is formatted date).
footer-left	authors.map(author => author.name).join(", ")	Left footer (default is author names).
footer-center	none	Center footer content.
footer-right	counter(page).display("1")	Right footer (default shows page number).
abstract-title	""	Title of the abstract section.
abstract	""	Content of the abstract.
thanks-title	""	Title of the acknowledgments section.
thanks	""	Content of the acknowledgments section.
glossary	none	Path to a YAML file with the glossary.
smart	true	Enables smart quotes.
equation-numbering	none	Controls equation numbering style.
header-includes	[]	Additional Typst or Markdown code to include in the header.
include-before	[]	Content included before the main document body.
include-after	[]	Content included after the main document body.

More Images

Image	Tables

Code Listing	Bibliography

No header and footers	No text justify and custom header and footer strokes

Alerts	Diagrams