Tiramisu Docs

Writing

Métadonnées de page

Chaque page de documentation commence par un bloc meta qui définit les métadonnées utilisées pour la barre latérale, la recherche et le SEO.

Syntaxe

tiramisu 
meta {
  title = My Page,
  description = A brief description,
  order = 2,
  group = Guide,
  icon = book,
  author = Jane Doe
}

Champs

ChampTypeDescription
titleChaîneTitre de la page — affiché dans la barre latérale et l'onglet du navigateur
descriptionChaîneCourte description pour les balises méta SEO
orderNombrePosition de tri dans la barre latérale (le plus petit apparaît en premier)
groupChaîneNom du groupe dans la barre latérale (uniquement pour les fichiers à la racine)
lastEditedChaîne de dateRemplacer la date de dernière modification (sinon utilise git ou le mtime du fichier)
iconChaîneNom de l'icône (icône Lucide ou identifiant Iconify complet comme mdi:home)
imageChaîneChemin de l'image OG (relatif à la racine du site) ou URL absolue
authorChaîneNom de l'auteur — affiché sous la page et inclus dans le JSON-LD

Titre

Le champ title est le plus important — il contrôle ce qui apparaît dans la navigation de la barre latérale. S'il est omis, le slug du fichier est utilisé à la place.

Ordonnancement

Utilisez order pour contrôler la position des pages au sein de leur groupe dans la barre latérale. Les pages sont triées par ordre croissant — order = 1 apparaît en premier, order = 2 en second, et ainsi de suite. Les pages sans ordre ont une valeur par défaut de 999.

Groupes

Pour les fichiers à la racine (qui ne sont pas dans un dossier), le champ group détermine à quel groupe de la barre latérale la page appartient :

tiramisu 
meta { title = Getting Started, group = Guide, order = 1 }

Pour les fichiers dans des dossiers, le groupe est déterminé automatiquement par le nom du dossier — vous n'avez pas besoin de définir group.

Pages d'index des dossiers

Un fichier index.tiramisu dans un dossier définit le titre d'affichage du groupe :

src/docs
getting-started
index.tiramisu
installation.tiramisu

Si index.tiramisu a title = Getting Started, cela devient le titre du groupe dans la barre latérale. Sans cela, le nom du dossier est automatiquement mis en majuscules — getting-started devient "Getting Started".