LIB Documentation

This section documents the TiefDown project format and the library concepts TiefDownConverter builds on (manifest, templates, markdown projects, and the conversion pipeline).

If you’re looking for how to use the CLI, jump to the CLI docs.

Start here

• Welcome to TiefDown — what a TiefDown project is and why it exists.
• Project Structure & Directories — folder layout, template dir, and scratch dirs.
• Manifest — the manifest.toml schema, versioning, and examples.

Topics (by chapter)

• Project Model Overview — how the pieces fit together.
• Conversion Pipeline — queueing, copying, metadata merge, and converters.
• Templates — TeX/Typst/EPUB vs custom converter templates.
• Lua Filters — discovery and where filters run.
• Markdown Projects — input discovery/sorting, resources, and per-project metadata.
• Injections — header/body/footer injections and when they apply.
• Multi-file Output Model — one output per input file (CustomPreprocessors).
• Metadata Generation and Injection — project vs navigation metadata and how to access it.
• Smart Clean — pruning old conversion folders automatically.