From d1860ef6513b6080dbae23374372b19345944808 Mon Sep 17 00:00:00 2001 From: Geoffrey Arthaud <geoffrey.arthaud@developpement-durable.gouv.fr> Date: Thu, 9 Jan 2025 09:55:43 +0000 Subject: [PATCH] =?UTF-8?q?M=C3=A0j=20doc?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 33 +++------------------------------ 1 file changed, 3 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 3aaf08b..d75bba1 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,5 @@ -# Modèle DSFR Docs +# Comment utiliser DSFR Docs ? -> âš ï¸ *Pensez à modifier ce fichier pour indiquer tous les liens utiles :* +DSFR-Docs vous permet de créer des pages de documentation en ligne au format DSFR. Vous pouvez initialiser vous-même un tel projet, et la construction de la documentation est très facile. -- [Documentation au format DSFR](#) -- [Wiki pour modifier les pages](#) -- [Pour déployer le contenu du wiki](#) -> puis cliquer sur le bouton "Run pipeline" - -## Usage de DSFR Docs - -- 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 : - - ```markdown - - [Accueil](Home) - - Documents - - [Mode d'emploi](Mode-d'emploi) - - [Local Document](Local-Doc) - - [Autre lien](Sample-Markdown) - ``` - -## Déploiement - -`Build -> Pipelines -> Run pipeline en haut à droite` +[Guide de démarrage rapide et documentation de DSFR Docs](https://utiliser-dsfr-docs-5d19bb.gitlab-pages.din.developpement-durable.gouv.fr/) -- GitLab