Tiramisu Docs

Getting Started

Quick Start

Create your first documentation page, understand meta blocks, and learn file-based routing.

Once you have a project set up, create your first documentation page.

Create a Page

Create a file at src/docs/getting-started.tiramisu:

tiramisu 
meta { title = Getting Started, order = 1 }

Welcome to my documentation!

h2 { Installation }

codeblock { language = bash, "bun add my-package" }

h2 { Usage }

Import and use the package:

codeblock { language = typescript, "import { something } from 'my-package'" }

Understanding Meta

Every page starts with a meta block that defines page metadata:

FieldDescription
titlePage title shown in the sidebar
orderSort order — lower numbers appear first
groupSidebar group name (for root-level files)
descriptionPage description for SEO
iconIcon name for the page heading
imageOG image path or URL
authorAuthor name shown below the page

Run the Dev Server

Start the development server:

bash 
bun run dev

Open http://localhost:5173/docs in your browser. Your page appears in the sidebar automatically.

File-Based Routing

The file path determines the URL:

FileURL
src/docs/index.tiramisu/docs
src/docs/guide.tiramisu/docs/guide
src/docs/apidpoints.tiramisu/docs/apidpoints

Folders automatically create sidebar groups. An index.tiramisu inside a folder sets the group's title.