Tiramisu Docs

tiramisudocs.com

A documentation framework built on SvelteKit and the Tiramisu markup language. Write .tiramisu files, get a fully themed documentation site with search, i18n, SEO, and an MCP server for AI assistants.

Write this

callout { type = warning, Don't forget to install the peer dependencies. }

codetabs {
  group = pkg,
  codetab { label = npm, language = bash, npm install my-package },
  codetab { label = yarn, language = bash, yarn add my-package }
}

Not this

import { Callout } from '../components/Callout'
import { Tabs, Tab } from '../components/Tabs'

<Callout type="warning">
  Don't forget to install the **peer
  dependencies**.
</Callout>

<Tabs items={['npm', 'yarn']}>
  <Tab value="npm">
    ```bash
    npm install my-package
    ```
  </Tab>
  <Tab value="yarn">
    ```bash
    yarn add my-package
    ```
  </Tab>
</Tabs>

Packages

The playground/ directory is a reference documentation site that demonstrates all features.

Quick Start

bun create tiramisu-docs my-docs
cd my-docs
bun dev

Write documentation in src/docs/ using .tiramisu files. Pages are automatically routed and added to the sidebar.

Development

This is a Bun workspace monorepo.

# Install dependencies
bun install

# Build all packages
bun run build

# Run all tests
bun test

# Run the playground dev server
cd playground && bun dev

Workspace Structure

tiramisu-docs/
├── packages/
│   ├── core/           # Compiler & meta extraction
│   ├── kit/            # Vite plugin, components, theme
│   └── create-tiramisu-docs/  # CLI scaffolder
├── playground/         # Reference docs site
└── docs/plans/         # Design & implementation docs

How It Works

1. Write — Author pages in .tiramisu files with meta { title = ... } frontmatter
2. Build — The Vite plugin compiles .tiramisu to Svelte components and generates a virtual module with docs, search index, and sidebar
3. Ship — Deploy as any SvelteKit app (serverless, edge, Node.js, static)

Tech Stack

• SvelteKit 2 + Svelte 5
• Tailwind CSS 4 + shadcn-svelte
• Shiki for syntax highlighting
• MiniSearch for client-side search
• KaTeX + Mermaid for math and diagrams

License

Apache 2.0