Premiers pas

Tiramisu Docs est un framework de documentation propulsé par SvelteKit et le langage de balisage Tiramisu. Rédigez vos documents dans des fichiers .tiramisu et obtenez un site de documentation moderne et soigné.

Fonctionnalités

• Routage basé sur les fichiers — déposez des fichiers .tiramisu dans src/docs/ et les pages apparaissent automatiquement
• Recherche intégrée — recherche plein texte dans toute votre documentation
• Coloration syntaxique — propulsée par Shiki avec la prise en charge de dizaines de langages
• Mode sombre — basculement automatique du thème avec les variantes claire et sombre
• Sections — organisez la documentation en plusieurs sections de premier niveau avec des barres latérales indépendantes
• i18n — internationalisation intégrée avec changement de langue et système de repli
• SEO — génération de sitemap, llms.txt, et skill.md dès l'installation
• Serveur MCP — permettez aux assistants IA de parcourir votre documentation via le Model Context Protocol
• Composants personnalisés — étendez avec vos propres composants Svelte

Comment ça marche

Vous rédigez la documentation en balisage Tiramisu — une syntaxe simple basée sur des appels de fonctions :

meta { title = Welcome, order = 1 }

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

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

Le plugin Vite compile les fichiers .tiramisu en composants Svelte au moment du build, générant automatiquement la navigation de la barre latérale, l'index de recherche et les métadonnées des pages.

Étapes suivantes