Barre latérale

La barre latérale est générée automatiquement à partir de votre structure de fichiers. Vous pouvez contrôler l'ordre et le regroupement des éléments via la configuration et les métadonnées des fichiers.

Ordre des groupes

Utilisez sidebar.groupOrder pour contrôler l'ordre d'apparition des groupes dans la barre latérale :

sidebar: {
  groupOrder: ["Getting Started", "Writing", "Configuration", "Advanced"],
},

Les groupes non listés dans groupOrder apparaissent après ceux listés, triés par ordre alphabétique.

Regroupement par dossier

Les dossiers de votre répertoire de documentation deviennent automatiquement des groupes dans la barre latérale. Le nom du dossier est converti en titre (par exemple, getting-started devient « Getting Started »).

Pour personnaliser le libellé d'un groupe, ajoutez un fichier index.tiramisu dans le dossier :

meta {
  title = My Custom Group Name
}

Le title du fichier d'index devient le libellé du groupe dans la barre latérale.

Regroupement au niveau racine

Les fichiers à la racine d'une section (pas dans un sous-dossier) peuvent être regroupés en utilisant le champ group dans leur bloc meta :

meta {
  title = My Page,
  group = Getting Started,
  order = 1
}

Ordonner les pages

Les pages au sein d'un groupe sont triées par leur valeur order (les nombres les plus bas apparaissent en premier). Si aucun ordre n'est spécifié, les pages sont triées par ordre alphabétique de titre.

meta {
  title = Installation,
  order = 2
}

Sous-groupes

Les dossiers imbriqués créent des sous-groupes dans la barre latérale. Ceux-ci apparaissent comme des sections repliables au sein de leur groupe parent :

Le fichier index.tiramisu dans writing/ définit le libellé du groupe « Writing ». Le fichier index.tiramisu dans content/ définit le libellé du sous-groupe « Content ».