Config

Everything in dokt is a controlled with a single TOML config file. If you aren't familiar with TOML syntax you can read more here. Every key in the config file is optional, there are defaults in place for every value. Unknown keys are an error, so typos do not pass silently. Run dokt init to generate a config file where each default is set explicitly and each setting is explained.

Top-level

These have to come before any of the config below.

Key Default Meaning
title folder name shown in the sidebar, page titles and PDF cover
out_dir "dokt-out" where build, serve and export write
include ["**"] globs of files to consider
exclude [] gitignore-style patterns to skip
default_excludes true also skip node_modules/, .git/, /target/
respect_gitignore true honor .gitignore files
allow_html true allow raw HTML to pass through Markdown
css [] paths to additional stylesheets. Imported with priority over the standard styles

Choosing what is published

All paths are relative to dokt.toml. dokt writes only into out_dir. It refuses to write into a non-empty folder it did not create, and never into the project root or one of its parents.

Example

title = "My app"
out_dir = "docs_out"
respect_gitignore = false
css = ["assets/globals.css"]

TODOs

These options are part of the [todos] table. They offer control over how the TODOs are parsed and understood. See Todos for more

Key Default Meaning
enabled true highlight and collect TODOs
markers ["TODO"] words that mark a TODO
files ["TODO.md"] file names whose every list item is a TODO

Example

[todos]
enabled = true
files = ["TaskList.md"]

Brand

These options are a part of the [brand] table. The allow you to control the branding elements for your generated documentation, see Branding for more information.

Key Default Meaning
logo none image beside the title
logo_dark none logo for the dark theme (needs logo)
favicon the logo browser tab icon
show_title true false shows only the logo
footer none plain text at the bottom of every page

Example

[brand]
logo = "assets/logo-black.png"
logo_dark = "assets/logo-white.png"
footer = "Copyright 2026 Acme Inc."

Export

These options are a part of the [export] table. This lets you control how the documentation is exported as a PDF, see Export for more information.

Key Default Meaning
paper "a4" "a4" or "letter"
browser found automatically path to Chrome, Chromium or Edge

Example

[export]
paper = "letter"
browser = "/usr/bin/google-chrome-bin"

Theme

These options are a part of the [theme] table. These let you change the colors used in your generated website and/or PDF, see Themes for more information. PDFs always use the light theme. See Export for more information on exported PDFs

Key Default Meaning
mode "auto" "auto", "light" or "dark"
toggle true show the theme button (only in auto mode)
[theme.light], [theme.dark] built in bg fg muted line soft accent broken todo

Example

[theme]
mode = "auto"
toggle = true

[theme.dark]
bg = "#01000C"
fg = "#E3ECF7"
accent = "#F7AC42"