Getting Started
Créez votre première page de documentation, comprenez les métadonnées et le routage basé sur les fichiers.
Une fois votre projet mis en place, créez votre première page de documentation.
Créer une page
Créez un fichier à l'emplacement src/docs/getting-started.tiramisu :
meta { title = Getting Started, order = 1 }
Welcome to my documentation!
h2 { Installation }
codeblock { language = bash, "bun add my-package" }
h2 { Usage }
Import and use the package:
codeblock { language = typescript, "import { something } from 'my-package'" }Comprendre les métadonnées
Chaque page commence par un bloc meta qui définit les métadonnées de la page :
| Champ | Description |
|---|---|
title | Titre de la page affiché dans la barre latérale |
order | Ordre de tri — les nombres les plus bas apparaissent en premier |
group | Nom du groupe dans la barre latérale (pour les fichiers à la racine) |
description | Description de la page pour le SEO |
icon | Nom de l'icône pour l'en-tête de la page |
image | Chemin ou URL de l'image OG |
author | Nom de l'auteur affiché sous la page |
Lancer le serveur de développement
Démarrez le serveur de développement :
bun run devOuvrez http://localhost:5173/docs dans votre navigateur. Votre page apparaît automatiquement dans la barre latérale.
Routage basé sur les fichiers
Le chemin du fichier détermine l'URL :
| Fichier | URL |
|---|---|
src/docs/index.tiramisu | /docs |
src/docs/guide.tiramisu | /docs/guide |
src/docs/apidpoints.tiramisu | /docs/apidpoints |
Les dossiers créent automatiquement des groupes dans la barre latérale. Un fichier index.tiramisu à l'intérieur d'un dossier définit le titre du groupe.
Info
Modifiez n'importe quel fichier
.tiramisu et le navigateur se recharge instantanément — le plugin Vite gère le remplacement de module à chaud.