Apprenez à créer des pages de documentation avec les fichiers .tiramisu, les métadonnées et le routage.
Les pages de documentation sont des fichiers .tiramisu placés dans le répertoire src/docs/. Chaque fichier devient une page de votre site.
Emplacement des fichiers
Placez vos fichiers dans src/docs/ (ou dans un sous-dossier de langue comme src/docs/ si vous utilisez l'i18n). Le chemin du fichier détermine l'URL :
| Chemin du fichier | URL |
|---|---|
src/docs/index.tiramisu | /docs |
src/docs/guide.tiramisu | /docs/guide |
src/docs/api/auth.tiramisu | /docs/api/auth |
Structure des dossiers
Les dossiers créent automatiquement des groupes dans la barre latérale. Un dossier contenant un fichier index.tiramisu utilise le titre de la page d'index comme libellé du groupe :
src/docs
index.tiramisu
getting-started
index.tiramisu
installation.tiramisu
quick-start.tiramisu
api
index.tiramisu
endpoints.tiramisu
Anatomie d'une page
Chaque page comporte deux parties : un bloc meta et le contenu.
meta { title = Ma Page, order = 2, group = Guide }
Texte de paragraphe ici. Utilisez bold { gras } et italic { italique } pour mettre en valeur.
h2 { Une section }
Plus de contenu avec du code { code en ligne } et d'autres mises en forme.Info
Le bloc
meta doit apparaître tout au début du fichier. Tout ce qui suit est affiché comme contenu de la page.Warning
N'ajoutez pas de
h1 {} à votre page — le title du bloc meta est automatiquement affiché comme titre de la page. Ajouter un h1 manuellement créerait un doublon.