Contenu
Contenu riche
Utilisez les encadrés, étapes, onglets, accordéons, citations, badges et listes de tâches intégrés.
Composants intégrés pour du contenu interactif et mis en valeur.
Encadrés
Mettez en évidence les informations importantes avec des encadrés :
callout { type = info, This is an informational callout. } Quatre types sont disponibles :
Preview
Info
Info — informations générales et astuces.
Warning
Avertissement — quelque chose à surveiller.
Error
Erreur — problèmes critiques ou changements incompatibles.
Success
Succès — confirmations et résultats positifs.
Étapes
Instructions numérotées :
steps {
Install the package:
codeblock { language = bash, npm i -S the-package },
Configure your project:
codeblock { language = bash, npx the-package --configure },
Start the dev server:
codeblock { language = bash, npm run dev}
} Preview
- Installez le paquet :
bash npm i -S the-package - Configurez votre projet :
bash npx the-package --configure - Lancez le serveur de développement :
bash npm run dev
Onglets
Sections de contenu à onglets avec persistance optionnelle par groupe :
tabs { group = platforms,
tab { label = macOS, icon = uim:apple, Instructions for macOS. },
tab { label = Linux, icon = uim:linux, Instructions for Linux. },
tab { label = Windows, icon = uim:windows, Instructions for Windows. }
} Preview
Instructions pour macOS.
Lorsque plusieurs blocs tabs partagent la même valeur group, sélectionner un onglet dans l'un synchronise automatiquement la sélection dans tous les autres. Le choix est conservé dans localStorage.
Accordéon
Contenu repliable :
accordion { title = Click to expand, Hidden content goes here. } Preview
Citations
quote { The best documentation is the documentation that exists., author = Unknown } Preview
La meilleure documentation est celle qui existe.
Badges
Indicateurs de statut en ligne :
badge { Stable }
badge { variant = secondary, Beta }
badge { variant = destructive, Deprecated }
badge { variant = outline, v2.0 } Preview
Stable Bêta Obsolète v2.0
Listes de tâches
tasklist {
"[x] Write documentation",
"[x] Add examples",
"[ ] Review and publish"
} Preview
- Rédiger la documentation
- Ajouter des exemples
- Relire et publier