Mise en page avec le thème mkdocs-dsfr

La mise en page avec le thème mkdocs-dsfr se base sur une mise en page standard du DSFR :

• Un en-tête avec le logo du ministère, le titre, le sous-titre, et une barre de recherche ;
• Un menu de navigation conforme au DSFR ;
• Un contenu principal avec des sections et des sous-sections ;
• Un menu latéral pour la navigation dans le contenu.
• Un pied de page avec des informations de contact et des liens.

Les composants optionnels de mise en page

Le thème mkdocs-dsfr permet d'ajouter des composants optionnels de mise en page. Ce sont des composants DSFR qui n'apparaissent qu'une fois par page, à une place prédéfinie. Vous pouvez consulter la liste des composants uniques par page pour les ajouter.

Configuration d'un composant unique par page

Les composants uniques par page sont configurés dans les métadonnées du fichier Markdown de la page. Voici un exemple de configuration pour le menu latéral, le fil d'Ariane et le sommaire :

---
sidemenu: true
breadcrumb:
  - Accueil: /
  - Composants: /composants/
  - Fil d'Ariane
summary: true
---

# Titre de la page

Contenu de la page avec le menu latéral, le fil d'Ariane et le sommaire.

Consultez la documentation de chaque composant unique par page pour connaitre sa configuration.

Le système de grille

Le thème mkdocs-dsfr utilise un système de grille basé sur le DSFR pour organiser le contenu sur plusieurs colonnes. Consultez la documentation du composant grille pour en savoir plus sur sa configuration.

Afficher les dates de création et de modification par page

En ajoutant le plugin document_dates dans votre configuration MkDocs, vous pouvez afficher les dates de création et de modification de chaque page :

plugins:
  - document_dates:
      position: top

L'option de position est bottom par défaut, mais accepte aussi les options top et disabled. Si la position topou bottom est choisie, les dates seront affichées sur toutes les pages, sauf la page d'accueil.

Vous pouvez aussi configurer page par page sur le front matter de la page Markdown avec la métadonnée date:

---
date:
  creation: 2024-01-01
  modification: 2024-01-15
  position: top
---

Vous pouvez ainsi modifier la position, ainsi que les dates elles-mêmes (format YYYY-MM-DD), pour la page courante uniquement. Si vous voulez activer la date que pour certaines pages, utilisez le plugin avec position: disabled et activez la date uniquement sur les pages souhaitées avec le front matter.