Options du thème DSFR

Dans votre fichier de configuration mkdocs.yml, vous pouvez définir les options de thème pour personnaliser votre site. Voici les options de thème disponibles et leurs valeurs par défaut :

theme:
  name: dsfr
  locale: fr
  # Configuration par défaut (modifiable)
  afficher_bouton_editer: true
  afficher_date_de_revision: false
  afficher_menu_lateral: true
  afficher_sommaire: false
  bouton_hautdepage: left
  include_search_page: true
  intitule: "République <br> française"
  libelle_bouton_editer: Éditer dans Gitlab Forge
  header:
    titre: "Titre"
    sous_titre: "Sous-titre"
  footer:
    description: "Description à modifier"
    links:
      - name: legifrance.gouv.fr
        url: https://legifrance.gouv.fr
      - name: gouvernement.fr
        url: https://gouvernement.fr
      - name: service-public.fr
        url: https://service-public.fr
      - name: data.gouv.fr
        url: https://data.gouv.fr

Options du thème

name

Le nom du thème. Il doit être défini sur dsfr.

locale

La locale pour le thème. Il doit être défini sur fr pour le français.

afficher_bouton_editer

Afficher ou masquer le menu latéral. Définissez-le sur true ou false.

afficher_date_de_revision

Afficher la date de dernière révision du document, à partir de Git. Cela suppose que vous utilisez un dépôt Git pour gérer votre documentation. Si vous utilisez un autre système de gestion de version, cette option ne fonctionnera pas. De plus, vous devez ajouter le plugin git-revision-date-localizeddans la définition des plugins, sous search :

plugins:
  - search:
      lang: fr
  - git-revision-date-localized

afficher_menu_lateral

Afficher ou masquer le menu latéral sur l'ensemble de la documentation.

afficher_sommaire

Afficher ou masquer le sommaire sur l'ensemble de la documentation. Le sommaire est un menu de navigation qui s'affiche en haut de chaque page, permettant de naviguer rapidement dans le contenu.

bouton_hautdepage

Définir la position du bouton de retour en haut de page, affiché pour les pages longues (de longueur supérieure à deux fois la hauteur de l'écran). Les valeurs possibles sont left, right ou false pour le désactiver.

include_search_page

afficher et utiliser la barre de recherche. C'est une option standard dans MkDocs.

libelle_bouton_editer

Personnaliser le libellé de bouton d'édition.

intitule

Cette option définit l'intitulé du ministère dans le logo de l'en-tête et du pied de page. Utilisez les balises <br> pour aller à la ligne en fonction de la charte de chaque ministère.

Options de l'en-tête avec header

titre

Définir le titre qui apparaît dans l'en-tête de la page.

soustitre

Définir le sous-titre qui apparaît sous le titre dans l'en-tête de la page.

description

Définir une description qui apparaît dans le pied de page.

links

Lister les liens qui apparaîtront dans le pied de page. Chaque lien doit être un dictionnaire YAML avec des clés name et url.

Comme tout document créé avec Mkdocs, le menu de navigation est défini dans le fichier mkdocs.yml sous la clé nav. Voici un exemple de configuration :

nav:
  - Accueil: index.md
  - Guide de démarrage: guide.md
  - Référence API: api.md
  - À propos: about.md

Pour en savoir plus sur la configuration du menu de navigation, consultez la documentation officielle de Mkdocs.

Options du thème DSFR