typstgen.toml
The config file that sets template directories and fonts, where typstgen looks for it, and its defaults.
Lookup
- The file passed with
--config(CLI) orConfig::load(Some(path))(library). - Otherwise
./typstgen.tomlin the working directory, if it exists. - Otherwise the defaults below.
Keys
| Key | Type | Default | Meaning |
|---|---|---|---|
template_paths |
array of paths | ["./templates", "./.typstgen/templates"] |
Directories searched for imports, in order, after the input’s own folder. Missing entries and files are skipped; none has to exist. |
font_paths |
array of paths | [] |
Extra font directories or font files. Native builds only. |
use_system_fonts |
boolean | true |
Add the fonts installed on the machine. Native builds only. |
template_paths = ["templates", "."]
font_paths = ["fonts"]
use_system_fonts = false
-
Paths are relative to the working directory, not to the config file.
-
Keys you leave out keep their default. Unknown keys are ignored.
-
A value of the wrong type stops typstgen with the TOML error and exit code
1:error: invalid config: TOML parse error at line 1, column 18 | 1 | template_paths = 3 | ^ invalid type: integer `3`, expected a sequence
How the template directory is chosen and imports are resolved is described in Templates and imports; fonts in Fonts.