Tiramisu Docs

Getting Started

Install Tiramisu Docs and create your first documentation page in minutes.

Tiramisu Docs is a documentation framework powered by SvelteKit and the Tiramisu markup language. Write your docs in .tiramisu files and get a polished, modern documentation site.

Features

  • File-based routing — drop .tiramisu files in src/docs/ and pages appear automatically
  • Built-in search — full-text search across all your documentation
  • Syntax highlighting — powered by Shiki with support for dozens of languages
  • Dark mode — automatic theme switching with light and dark variants
  • Sections — organize docs into multiple top-level sections with independent sidebars
  • i18n — built-in internationalization with locale switching and fallback
  • SEO — sitemap, llms.txt, and skill.md generation out of the box
  • MCP server — let AI assistants browse your docs via Model Context Protocol
  • Custom components — extend with your own Svelte components

How It Works

You write documentation in Tiramisu markup — a simple, function-call-based syntax:

tiramisu
meta { title = Welcome, order = 1 }

This is a paragraph with bold { bold text } and code { inline code }.

codeblock { language = bash, "npm install my-lib" }

The Vite plugin compiles .tiramisu files into Svelte components at build time, generating sidebar navigation, search index, and page metadata automatically.

Next Steps