Learn how to create documentation pages with file-based routing, folder structure, and meta blocks.
Documentation pages are .tiramisu files inside the src/docs/ directory. Each file becomes a page on your site.
File Location
Place your files in src/docs/ (or in a locale subfolder like src/docs/ if using i18n). The file path determines the URL:
| File Path | URL |
|---|---|
src/docs/index.tiramisu | /docs |
src/docs/guide.tiramisu | /docs/guide |
src/docs/api/auth.tiramisu | /docs/api/auth |
Folder Structure
Folders create sidebar groups automatically. A folder with an index.tiramisu file uses the index page's title as the group label:
src/docs
index.tiramisu
getting-started
index.tiramisu
installation.tiramisu
quick-start.tiramisu
api
index.tiramisu
endpoints.tiramisu
Page Anatomy
Every page has two parts: a meta block and content.
meta { title = My Page, order = 2, group = Guide }
Paragraph text goes here. Use bold { bold } and italic { italic } for emphasis.
h2 { A Section }
More content with code { inline code } and other formatting.Info
The
meta block must appear at the very beginning of the file. Everything after it is rendered as page content.Warning
Do not add an
h1 {} to your page — the title from the meta block is automatically rendered as the page heading. Adding a manual h1 would create a duplicate.