Menu latéral
L'option du thème afficher_menu_lateral permet d'afficher ou de masquer le menu latéral sur l'ensemble de la documentation. Par défaut, il est activé.
theme:
name: dsfr
locale: fr
afficher_menu_lateral: true
... # autres options du thème
Il est possible de désactiver (ou inversement, activer) le menu latéral pour une page spécifique en utilisant la métadonnée sidemenu en en-tête du fichier Markdown de la page concernée.
---
sidemenu: false
---
# Titre de la page
Contenu de la page sans menu latéral.
Dépréciation de la métadonnée template
L'utilisation de la métadonnée template (avec comme valeur main_no_lateral.html ou main_lateral.html) pour désactiver le menu latéral est dépréciée, et sera supprimée prochainement. Il est recommandé d'utiliser sidemenu à la place, comme indiquée ci-dessus.
Mode d'affichage du menu latéral
Le menu latéral peut fonctionner selon deux modes : page (par défaut) et dossier.
Mode page (par défaut)
En mode page, le menu latéral affiche le sommaire de la page courante, basé sur les titres de la page (table des matières). C'est le comportement par défaut.
Mode dossier
En mode folder, le menu latéral affiche une navigation basée sur l'arborescence réelle des fichiers source de la documentation (les dossiers dans docs/). Les pages qui partagent un même dossier parent sont regroupées dans le menu latéral, ce qui permet de naviguer entre les pages voisines sans passer par le menu principal. Les titres affichés dans le menu sont les titres réels des pages.
Les pages situées à la racine de docs/ (sans sous-dossier) ne bénéficient pas du mode dossier : le menu latéral revient automatiquement au mode page (sommaire de la page courante). Les éventuels sous-dossiers sont affichés sous forme de sous-menus dépliables.
Pour activer le mode dossier de manière globale, ajoutez la configuration menu_lateral dans les options du thème :
theme:
name: dsfr
locale: fr
afficher_menu_lateral: true
menu_lateral:
mode: folder
Il est également possible de définir le mode du menu latéral pour une page spécifique en utilisant la métadonnée sidemenu_mode en en-tête du fichier Markdown :
---
sidemenu: true
sidemenu_mode: folder
---
# Titre de la page
Contenu de la page avec un menu latéral en mode dossier.
Plugin dsfr_base requis
Le mode dossier nécessite le plugin dsfr_base pour construire l'arborescence de navigation. Assurez-vous qu'il est bien déclaré dans la liste des plugins de votre fichier mkdocs.yml.
Les valeurs possibles pour sidemenu_mode et menu_lateral.mode sont :
| Valeur | Description |
|---|---|
| page | Affiche le sommaire de la page courante (titres de la page). Comportement par défaut. |
| folder | Affiche la navigation basée sur l'arborescence des fichiers source du dossier courant (structure des dossiers dans docs/). |