Reference
Complete reference documentation for Zorto.
- CLI reference: command-line interface
- Python API reference: programmatic site loading, building, and inspection
- Rust API reference: docs.rs links and key types
- Configuration reference: complete config.toml reference
- Shortcodes reference: built-in shortcodes with live demos
- Callouts reference: GitHub-style callout alert types and syntax
- Frontmatter reference: all frontmatter fields for pages and sections
- Content directories reference:
content_dirsconfiguration fields - Taxonomies reference: taxonomy configuration and template variables
- Template functions reference: custom functions, filters, and tests
CLI reference
The zorto command-line interface. See installation for setup, live reload for preview server details, and troubleshooting for common issues.
Callouts reference
Zorto supports GitHub-style callout alerts. Use blockquote syntax with a type marker. See callouts concept for when to use callouts vs shortcodes.
Configuration reference
Complete reference for config.toml. See configuration concept for the mental model and examples. The tables below are auto-generated from the Zorto source code.
Content directories
Pull content from outside the content/ directory using [[content_dirs]] in config.toml. This is ideal for documentation that lives alongside source code, or content shared between multiple sites.
Frontmatter reference
Complete specification for TOML frontmatter in Zorto content files. Frontmatter is enclosed in +++ delimiters at the top of every .md file.
Python API
Zorto's Python API lets you load, inspect, and build sites programmatically. Install the package:
Rust API
Zorto's Rust API is documented on docs.rs.
Shortcodes reference
Complete reference for all built-in shortcodes. See shortcodes concept for an overview and how to customize your theme for creating custom shortcodes.
Taxonomies in depth
Taxonomies let you classify content with terms like tags, categories, or any custom grouping. Zorto auto-generates listing pages for each taxonomy and its terms.
Template functions and filters
Zorto registers custom template functions, filters, and tests on top of the Tera template engine. This page is the complete reference.