Configuration

Configuration options can be supplied as either command line arguments, or in a YAML configuration file.

Examples are provided at the bottom of the page.

Command line arguments

Specify the name of the option prefixed by two hyphens, followed by the value: typ typeset --[name] [value].

There exist some command line specific arguments. See Command Line for details.

Configuration files

Put your configuration in a file called config.yaml. Typ will automatically use it if present in your Project.

Configuration reference

General options

Option name Description Example
title The title of the document Alice in Wonderland
generateTableOfContents Whether to generate a table of contents based on headings true or false
printPageNumbers Whether to print page numbers true or false
printTitleMarginals Whether to print the chapter title in a top corner, and the document title in the bottom corner true or false
pdfTkPath (optional) Path to the PDFtk Server executable. See Installation. C:\Programs\bin\pdftk.exe

Formatting options

These options control what the formatting of the document looks like.

These options generally have an equivalent CSS property. For instance, textLineHeight maps to line-height, so could be set to normal, 2.5, 3em, and so on.

The links under the 'CSS' heading for each option have more information about valid values.

Option name Description CSS Example
textLineHeight Sets the distance between lines of text line-height 2.5
pageMargin The margin between the edge of the page and the content margin 10px
pageSize The size of the page size A5, 4in 6in
fontFamily Font for all text content. Currently supported fonts: georgia, times new roman, arial & verdana font-family verdana

Example config.yaml file

title: My document
fontFamily: Arial
pageSize: A5
pageMargin: 70pt 60pt 70pt
textLineHeight: 200%
fontSize: 12pt
generateTableOfContents: false
printPageNumbers: false
printTitleMarginals: false
pdfTkPath: C:\Programs\bin\pdftk.exe

Example typ typset command line call

typ typset --title My document --pageMargin 70pt 60pt 70pt --generateTableOfContents false