Navigation

La navigation de la documentation est générée automatiquement à partir de la structure des répertoires de pages/docs/ : il n’y a rien à configurer.

Barre latérale

La barre latérale est construite à partir des sections imbriquées : chaque sous-répertoire contenant un fichier index.md devient un groupe repliable, quelle que soit sa profondeur.

pages/docs/
├─ index.md            → /docs/
├─ 1-getting-started.md
└─ guides/
   ├─ index.md         → groupe « Guides »
   ├─ 1-notes.md
   └─ advanced/
      ├─ index.md      → groupe « Advanced », dans « Guides »
      └─ 1-customization.md

Le fichier index.md d’un groupe définit son titre, sa description et sa position ; son contenu est affiché sur la page du groupe, suivi de la liste de ses pages :

---
title: Guides
description: Tutoriels et instructions.
weight: 20
---
Les guides sont un ensemble de tutoriels pour vous aider à comprendre comment utiliser Statidocs.

Ordre

Les pages et les groupes sont triés par weight (poids, par ordre croissant) :

pour une page, utilisez un préfixe numérique dans le nom du fichier (par exemple 1-getting-started.md) ou la variable de front matter weight ;
pour un groupe, utilisez la variable de front matter weight dans son fichier index.md.

Groupes repliés

Les groupes sont ouverts par défaut. Pour replier un groupe, définissez collapsed: true dans le front matter de son fichier index.md :

---
title: Advanced
collapsed: true
---

Pour replier tous les groupes, utilisez l’option sidebar.collapsed dans la configuration :

sidebar:
  collapsed: true

Fil d’Ariane et liens précédent/suivant

Chaque page de documentation affiche un fil d’Ariane (basé sur ses ancêtres) et des liens vers les pages précédente et suivante, en suivant l’ordre de la barre latérale, à travers les groupes imbriqués.

Table des matières

La table des matières « Sur cette page » est générée à partir des titres (##, ###) de la page et met en évidence la section courante pendant le défilement.

Menus d’en-tête et de pied de page

Le menu main est affiché dans l’en-tête (et dans la barre latérale sur mobile), et le menu facultatif footer dans le pied de page :

menus:
  main:
    - id: docs
      name: Documentation
      url: /docs/
      weight: 10
  footer:
    - id: cecil
      name: Cecil
      url: https://cecil.app

Une page peut également être ajoutée à un menu depuis son front matter :

---
title: About
menu:
  main:
    weight: 999
---