Configuration

typst_documents

Type:

list[dict[str, Any]]

Default:

[
    {
        "startdocname": "index",
        "targetname": "main",
        "title": project,
    },
]

A list of documents to generate. By default, it generates a document main/main.typ from the index document.

Each document is represented as a dictionnary which have these attributes:

"startdocname"

Needed. The root document name. For example my/file.

"targetname"

Needed. The name of the generated file. The generated file will be under _build/typst/targetname/targetname.typ.

"title"

Needed. The main title of the document. Used for the title page.

"template"

Optional. The document template to use. See typst_template for more information.

Defaults to the value of typst_template.

"appendices"

Optional. A list of document names to add at the end of the document.

Defaults to []

"metadata"

Optional. A dictionary of extra metadata to pass to the Typst template. See Writing custom templates for more information.

Defaults to {}

typst_template

Type:

str

Default:

"default"

The Typst template to use.

Available templates:

"default"

A simple template that uses mostly default values from the Typst project

"charged-ieee"

A simple template that uses mostly default values from the Typst project

"ilm"

A simple template that uses mostly default values from the Typst project