Writing
Every documentation page starts with a meta block that defines metadata used for the sidebar, search, and SEO.
Syntax
meta {
title = My Page,
description = A brief description,
order = 2,
group = Guide,
icon = book,
author = Jane Doe
}Fields
| Field | Type | Description |
|---|---|---|
title | String | Page title — shown in the sidebar and browser tab |
description | String | Short description for SEO meta tags |
order | Number | Sort position in the sidebar (lower appears first) |
group | String | Sidebar group name (only for root-level files) |
lastEdited | Date string | Override the last-edited date (otherwise uses git or file mtime) |
icon | String | Icon name (Lucide icon or full Iconify ID like mdi:home) |
image | String | OG image path (relative to site root) or absolute URL |
author | String | Author name — displayed below the page and included in JSON-LD |
Title
The title field is the most important — it controls what appears in the sidebar navigation. If omitted, the file's slug is used instead.
Ordering
Use order to control the position of pages within their sidebar group. Pages are sorted by order ascending — order = 1 appears first, order = 2 second, and so on. Pages without an order default to 999.
Groups
For root-level files (not inside a folder), the group field determines which sidebar group the page belongs to:
meta { title = Getting Started, group = Guide, order = 1 }For files inside folders, the group is determined automatically by the folder name — you don't need to set group.
Folder Index Pages
An index.tiramisu file inside a folder sets the group's display title:
If index.tiramisu has title = Getting Started, that becomes the sidebar group heading. Without it, the folder name is title-cased automatically — getting-started becomes "Getting Started".
index.tiramisu in a subfolder makes the subgroup a clickable link.