Package: mkdocs-dsfr
Thème DSFR pour MkDocs DSFRATTENTION : Ce thème est uniquement destiné à être utilisé pour les sites et applications officiels des services
publics français. Son objectif principal est de faciliter l'identification des sites gouvernementaux pour les citoyens.Mentions légales.Démarrage rapidePour expérimenter rapidement mkdocs avec le DSFR, vous pouvez cloner
leprojet d'exemple.Configuration du dépôt et des liens d'éditionDans le fichiermkdocs.yml, trois configurations importantes sont définies pour permettre aux utilisateurs de naviguer
vers le dépôt source et d'éditer les pages directement :repo_url: URL du dépôt Git où le code source de la documentation est hébergé.edit_uri: Chemin relatif vers le dossier contenant les fichiers Markdown de la documentation dans le dépôt Git.edit_text: Texte à afficher pour le lien d'édition.Exemple de configurationDans ce projet, les configurations sont définies comme suit :repo_url: https://gitlab-forge.din.developpement-durable.gouv.fr/pub/numeco/mkdocs-dsfr/edit_uri: blob/main/docs/Comment cela fonctionnerepo_urlpointe vers le dépôt GitLab où se trouve le code source de la documentation.edit_uriindique le chemin relatif vers les fichiers Markdown dans ce dépôt.Si l'une de ces variables n'est pas remplie, le lien d'édition n'apparaîtra pas.Configuration du thème DSFR MkDocsCe document décrit les différentes options de configuration pour le thème DSFR MkDocs.
Dans votre fichier de configurationmkdocs.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:# Config par défaut (modifiable)include_search_page:trueafficher_date_de_revision:trueafficher_menu_lateral:trueafficher_bouton_editer:truelibelle_bouton_editer:Éditer dans Gitlab Forge# Ces valeurs sont à modifierintitule:"République<br>française"header:titre:"Titre"sous_titre:"Sous-titre"footer:description:"Descriptionàmodifier"links:-name:legifrance.gouv.frurl:https://legifrance.gouv.fr-name:gouvernement.frurl:https://gouvernement.fr-name:service-public.frurl:https://service-public.fr-name:data.gouv.frurl:https://data.gouv.frOptions de ThèmenameLe nom du thème. Il doit être défini sur 'dsfr'.localeLa locale pour le thème. Il est défini sur 'fr' pour le français.include_search_pagePermet l'affichage et l'utilisation de la barre de recherche.afficher_date_de_revisionPermet d'afficher la date de dernière révision git.
Valeur booléenne qui permet d'afficher ou de masquer la date de la dernière révision de la page actuelle dans le pied de
page. Vous pouvez la définir surtruepour afficher la date, ou surfalsepour la masquer.Il est important de noter qu'en plus d'utiliser cette option, vous devez également installer le
pluginmkdocs-git-revision-date-localized-pluginpour que cela fonctionne.pip install mkdocs-git-revision-date-localized-pluginafficher_menu_lateralValeur booléenne pour afficher ou masquer le menu latéral. Définissez-le surtrueoufalse.afficher_bouton_editerValeur booléenne pour afficher ou masquer le menu latéral. Définissez-le surtrueoufalse.libelle_bouton_editerPermet de personnaliser le libellé de bouton d'édition.intituleCette option définit le titre principal du logo dans l'en-tête et le pied de page.Options d'En-têtetitreCela définit le titre qui apparaît dans l'en-tête de la page.soustitreCela définit le sous-titre qui apparaît sous le titre dans l'en-tête de la page.Options de Pied de PagedescriptionCela définit une description qui apparaît dans le pied de page.linksCette option vous permet de définir une liste de liens qui apparaîtront dans le pied de page. Chaque lien doit être un
dictionnaire avec des clésnameeturl.Notes de versionVersion 0.7.1 (DSFR 1.11.0)Mise à jour du DSFRVersion 0.7.0 (DSFR 1.10.1)Coloration syntaxique du codeBouton copier-coller du codeCréation d'une extension pour la structure DSFR (contraintes CSS)Version 0.6.1 (DSFR 1.10.1)Correction de bug de paramètre de confChangement de nom du paramètrebutton_edit_labelVersion 0.6.0 (DSFR 1.10.1)Allègement du thèmeAffichage de la date de dernière révision dans le footer de la pageAjout d'un bouton pour modifier la page (redirection vers le dépôt source)Version 0.5.3 (DSFR 1.10.1)Correction documentation pour la fonction rechercheMise à jour DSFRVersion 0.5.2 (DSFR 1.10.0)Correction bug technique lié à la fonction rechercheVersion 0.5.1 (DSFR 1.10.0)Corrections pour prise en charge de la rechercheVersion 0.5.0 (DSFR 1.10.0)Prise en charge du texte barréPrise en charge des checkboxesMise à jour du DSFRVersion 0.4.0 (DSFR 1.9.3)Ajout de variables de configurationVersion 0.3.1 (DSFR 1.9.3)Correction de problèmes d'import et d'affichageVersion 0.3.0 (DSFR 1.9.3 Juin 2023)Ajout du composant paramètre d'affichage dans le footer pour la gestion des thèmes dark et lightVersion 0.2.0 (June 2023)Initial experimental version