typst-bake
Bake Typst templates, fonts, and packages into your Rust binary to create a fully self-contained PDF generation engine with zero runtime dependencies on the filesystem or network.
Features
- Simple API - Generate PDFs with just
document!("main.typ").to_pdf() - Minimal Setup - Just specify
template-dirandfonts-dirinCargo.tomlmetadata - File Embedding - All files in
template-dirare embedded and accessible from templates - Font Embedding - Fonts (TTF, OTF, TTC) in
fonts-dirare automatically bundled into the binary - Automatic Package Bundling - Scans templates for package imports, downloads them at compile time, and recursively resolves all dependencies
- Package Caching - Downloaded packages are cached in system cache directory for faster compilation. Use
TYPST_BAKE_REFRESH=1to force re-download - Runtime Inputs - Pass dynamic data from Rust structs to Typst via
IntoValue/IntoDictderive macros - Optimized Binary Size - Resources are compressed with zstd and decompressed lazily at runtime
- Smart Recompilation - File changes trigger recompilation automatically, with optional build script for complete coverage
Installation
Add to your Cargo.toml:
[]
= "0.1"
[]
= "./templates" # Path to your .typ files and assets
= "./fonts" # Path to your font files
Optional: Complete File Change Detection
By default, typst-bake detects template or font file modifications and triggers recompilation when you run cargo build. File additions and deletions are not detected directly, but this is rarely an issue—adding a new file usually requires modifying an existing file (like main.typ) to use it, which triggers recompilation anyway.
If you want to fully detect even the rare case where you only add or remove files without modifying existing ones, add a build script:
# Cargo.toml
[]
= "build.rs"
[]
= "0.1"
// build.rs
Quick Start
For a complete walkthrough, see the Quick Start Guide (PDF).
Examples
| Example | Description | Command | Output |
|---|---|---|---|
| quick-start | Generates the Quick Start PDF using all features | cargo run -p example-quick-start |
|
| font-guide | Guide to font setup and usage | cargo run -p example-font-guide |
|
| with-inputs | Pass dynamic data from Rust to Typst | cargo run -p example-with-inputs |
|
| with-files | Embed images and various data files | cargo run -p example-with-files |
|
| with-package | Automatic package bundling | cargo run -p example-with-package |
License
MIT OR Apache-2.0