Super-Simple Includes Documentation

v0.244.0

Configuration Reference

SSI sites are configured with a single ssi-config.toml file in the site source directory. The file is a list of [[step]] entries, each defining a source and how it is processed.

Reference pages

Topic Description
ssi-config.toml structure Step fields, processing modes, and the [[step]] format
Include sources HTML, Markdown, plain text, and TOML include sources
File sources Page, copy, and preserve step types; file handling options
Data sources Built-in sources: git, datetime, environment, counter, navigation, index
Processing types Content type options: inline, adjust-headers, excerpt, and more
Per-page tokens Page-specific token values using TOML files alongside each page

Quick start

A minimal ssi-config.toml:

[[step]]
emoji = "📄"
path = "pages/"
processing = "page"

[[step]]
emoji = "📎"
path = "blocks/"
type = "html"

The emoji field defines the token used in page templates. A step with a given emoji means page files can reference content from that source using the emoji as a token prefix. The path is relative to the site source directory.