Sommaire
Ce composant permet de créer un sommaire DSFR.
Élément unique
Comme le sommaire est unique par page, il est déclaré dans les métadonnées du fichier Mardown source, et non comme un composant dans le contenu de la page.
Déclaration du sommaire
Par défaut, le sommaire n'est pas présent dans chaque page. Pour l'activer globalement, vous pouvez ajouter l'option afficher_sommaire: true dans le fichier mkdocs.yml de votre projet. Référez-vous à la liste des options de configuration pour en savoir plus.
Pour activer (ou désactiver) le sommaire uniquement sur certaines pages, dans l'en-tête du fichier Markdown, encadré par les symboles ---, ajoutez la section summary en précisant True(ou False) :
---
... autres métadonnées ...
summary: True
---
Exemple de déclaration
Dans l'exemple ci-dessous, le sommaire est activé et affichera tous les titres de niveau 2 et 3 de la page :
---
summary: True
---
# Ma page avec différents titres
Début de texte
## Titre de niveau 2
### Titre de niveau 3
Texte après le titre de niveau 3
## Titre de niveau 2-bis