Erste Schritte

Tiramisu Docs ist ein Dokumentations-Framework basierend auf SvelteKit und der Tiramisu-Auszeichnungssprache. Schreiben Sie Ihre Dokumentation in .tiramisu-Dateien und erhalten Sie eine elegante, moderne Dokumentationsseite.

Funktionen

• Dateibasiertes Routing — legen Sie .tiramisu-Dateien in src/docs/ ab und Seiten erscheinen automatisch
• Integrierte Suche — Volltextsuche über Ihre gesamte Dokumentation
• Syntaxhervorhebung — unterstützt von Shiki mit Unterstützung für Dutzende von Sprachen
• Dunkelmodus — automatischer Theme-Wechsel mit hellen und dunklen Varianten
• Sektionen — organisieren Sie Dokumentation in mehrere übergeordnete Sektionen mit unabhängigen Seitenleisten
• i18n — integrierte Internationalisierung mit Sprachwechsel und Fallback
• SEO — Sitemap, llms.txt und skill.md-Generierung sofort einsatzbereit
• MCP-Server — lassen Sie KI-Assistenten Ihre Dokumentation über das Model Context Protocol durchsuchen
• Eigene Komponenten — erweitern Sie mit Ihren eigenen Svelte-Komponenten

Wie es funktioniert

Sie schreiben Dokumentation in Tiramisu-Auszeichnung — einer einfachen, auf Funktionsaufrufen basierenden Syntax:

meta { title = Welcome, order = 1 }

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

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

Das Vite-Plugin kompiliert .tiramisu-Dateien zur Build-Zeit in Svelte-Komponenten und generiert automatisch Seitenleisten-Navigation, Suchindex und Seiten-Metadaten.

Nächste Schritte