Options du composant

Options du composant DSFR Docs

Vous pouivez ajouter des options à DSFR Docs, dans le fichier gitlab-ci.yml. De base, l'option intitule est déjà renseignée.

include:
  - component: gitlab-forge.din.developpement-durable.gouv.fr/share/components/dsfr-docs/dsfr-docs@~latest
    inputs:
      stage: deploy
      intitule: MINISTÈRES<br>AMÉNAGEMENT<br>DU TERRITOIRE<br>TRANSITION<br>ÉCOLOGIQUE

Vous pouvez la changer ou ajouter d'autres options. Le tableau ci-dessous liste les options disponibles.

Input	Valeur par défaut	Description
`bouton_editer`	true	Afficher le bouton de modification de page
`bouton_editer_libelle`	Éditer dans Gitlab Forge	Le libellé du bouton de modification de page
`bouton_hautdepage`	left	Bouton de retour en haut de page. Peut être 'left', 'right' ou 'false' pour le désactiver
`dossier_css`	extra_css	Le dossier contenant éventuellement des fichiers css addtionnels
`dossier_js`	extra_js	Le dossier contenant éventuellement des fichiers js addtionnels
`entete_titre`	\$CI_PROJECT_TITLE	Le titre du site. Par défaut, c'est le titre du projet Gitlab
`entete_description`	\$CI_PROJECT_DESCRIPTION	La description du site. Par défaut, c'est la description du projet Gitlab
`entete_recherche`	true	Inclure la barre de recherche
`intitule`	République Française	L'intitulé du ministère (utilisé pour le logo)
`menu_lateral`	true	Afficher le menu latéral
`mkdocs_plugins`		Les plugins additionnels mkdocs à utiliser, séparés par des virgules. Dans tous les cas, ces extensions sont utilisées : search et alternate-link
`mkdocs_extensions`		Les extensions additionnelles mkdocs à utiliser, séparées par des virgules. Dans tous les cas, ces extensions sont utilisées : dsfr_structure.extension.all_extensions, pymdownx.snippets, pymdownx.highlight, pymdownx.superfences, toc, attr_list, def_list et tables
`pied_description`	Site géré par l'État	La description du pied de page
`pied_liens`	legifrance.gouv.fr, gouvernement.fr, service-public.fr, data.gouv.fr	Les liens du pied de page. Les liens doivent être au format Markdown, séparés par des virgules
`pied_liens_bas`		Les liens du pied de page inférieur. Les liens doivent être au format Markdown, séparés par des virgules
`stage`	deploy	Le stage sur lequel est exécuté la génération de la page

Comment écrire sa documentation ?

Le titre du site et le sous-titre reprennent directement le titre du projet Gitlab et sa description
Toujours utiliser du markdown dans le wiki
Possibilité d'inclure des images externes
On peut utiliser l'insertion des diagrammes du wiki (qui fabrique un svg qui est ensuite importé comme image)
Le menu latéral du wiki Gitlab devient le menu principale de navigation en DSFR. Seuls les liens avec titre vers les pages internes au Wiki sont pris en compte.
Il est possible d'avoir un menu sur deux niveaux à condition que :
La barre latérale se présente comme une liste à puces
Les sous-menus ont une indentation (série d'espaces) en début de ligne
Le menu englobant les sous-menus est juste un texte et non un lien
Exemple :

- [Accueil](Home.md)
- Documents
    - [Mode d'emploi](Mode-d'emploi.md)
    - [Local Document](Local-Doc.md)
- [Autre lien](Sample-Markdown.md)

Déployer sa documentation

Build -> Pipelines -> Run pipeline en haut à droite.

Mkdocs DSFR

Pour comprendre comment intégrer des composants DSFR dans votre wiki, consultez la documentation officielle de mkdocs-dsfr, en particulier les composants.