Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

mdBook : Markdown : Chapitres de pages mdBook

Le rôle particulier du sommaire mdBook

Le sommaire mdBook est le contenu du fichier spécial SUMMARY.md où nous définissons et organisons les rubriques du sommaire mdBook et des chapitres du sommaire mdBook.
Voir Terminologie.

Il convient de commencer par travailler le plan de notre document au niveau du sommaire mdBook.

Il est ensuite possible de créer des chapitres dans chaque chaque page mdBook.

Nous les appelons chapitres de page mdBook pour les distinguer des chapitres du sommaire mdBook.

Les chapitres de page mdBook servent à articuler et organiser les contenus de nos pages mdBook.

Chapitres de page mdBook

La présence de caractère(s) # (suivis d’au moins une espace) en début de ligne indique au compilateur mdBook qu’il s’agit d’un chapitre de page mdBook.

Alors que # est associé aux rubriques du sommaire mdBook dans le sommaire mdBook, il sert à indiquer des chapitres de page mdBook dans les pages mdBook.

Niveaux des chapitres de page mdBook

mdBook copie le titre de chapitre du sommaire mdBook de la page mdBook au début du fichier.md lorsqu’il le crée.

mdBook lui associe un # qui indique un titre de niveau 1.

Nous utilisons donc des titres de niveau 2 minimum pour les chapitres de page mdBook pour tenir compte de cette convention, le niveau 1 étant réservé aux titres de chapitre du sommaire mdBook dans les fichiers.md.

Nous écrivons :

## Titre de niveau 2
### Titre de niveau 3
#### Titre de niveau 4
##### Titre de niveau 5

pour afficher :

Titre de niveau 2

Titre de niveau 3

Titre de niveau 4

Titre de niveau 5

Affichage dans la barre latérale

En fonction des options du projet mdBook, les chapitres de la page mdBook active peuvent être affichés dans la barre latérale au sein du sommaire mdBook.

Ce n’est pas ni permanent ni, d’ailleurs, recommandé à mon sens. Les choses sont déjà bien assez complexes comme cela.

Pour nous assurer de ne pas les afficher dans la barre latérale dans le sommaire mdBook, l’option à indiquer dans book.toml est :

output.html.sidebar-header-nav = false