{"id":14384214,"url":"https://github.com/codegouvfr/docsify-dsfr-template","last_synced_at":"2025-09-10T03:33:08.831Z","repository":{"id":206177736,"uuid":"715518215","full_name":"codegouvfr/docsify-dsfr-template","owner":"codegouvfr","description":"Un template pour construire un site de documentation en un instant avec le DSFR et docsify (alternative à GitBook).","archived":false,"fork":false,"pushed_at":"2024-12-26T15:38:53.000Z","size":661,"stargazers_count":6,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-11T13:13:23.047Z","etag":null,"topics":["bluehats","docsify","documentation","dsfr"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codegouvfr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-07T09:59:49.000Z","updated_at":"2024-12-26T15:38:56.000Z","dependencies_parsed_at":null,"dependency_job_id":"515c7c28-4e64-41c4-90df-2c6e1d654049","html_url":"https://github.com/codegouvfr/docsify-dsfr-template","commit_stats":null,"previous_names":["codegouvfr/docsify-dsfr-template"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codegouvfr%2Fdocsify-dsfr-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codegouvfr%2Fdocsify-dsfr-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codegouvfr%2Fdocsify-dsfr-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codegouvfr%2Fdocsify-dsfr-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codegouvfr","download_url":"https://codeload.github.com/codegouvfr/docsify-dsfr-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241231405,"owners_count":19931151,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bluehats","docsify","documentation","dsfr"],"created_at":"2024-08-28T18:01:13.444Z","updated_at":"2025-02-28T20:47:48.126Z","avatar_url":"https://github.com/codegouvfr.png","language":"HTML","readme":"[![img](https://img.shields.io/badge/code.gouv.fr-publi%C3%A9-orange.svg)](https://code.gouv.fr/documentation/#/publier)\n\nCe dépôt permet de générer un répertoire de documentation utilisant le [système de design de l'État (DSFR)](https://www.systeme-de-design.gouv.fr).\n\nLe rendu de la documentation utilise [docsify](https://github.com/docsifyjs/docsify).\n\n![Screenshot of an example documentation website using this template.](docsify-dsfr-template.png)\n\n## Fonctionnalités\n\n- Docsify génère les pages web directement depuis des fichiers Markdown. Il suffit d'ajouter un fichier `.md` et de l'intégrer au menu de gauche via `_sidebar.md` pour qu'il apparaisse dans le menu.\n- Le rendu visuel est configurable via les [options disponibles pour docsify](https://docsify.js.org/#/configuration).\n- Le rendu au DSFR est à jour avec la dernière version stable.\n\n## Utilisation\n\n- Téléchargez l'archive [`docsfr-[latest].tar.gz`](https://github.com/codegouvfr/docsify-dsfr-template/releases/latest/) lié à la dernière version du dépôt.\n- Adaptez le fichier `index.html` selon vos besoins. En particulier, si vous souhaitez que votre documentation pointe vers un dépôt Git, décommentez la ligne du script renseignant le `repo`.\n- Commencez à rédiger votre documentation en Markdown dans ce répertoire.\n- Publiez ce répertoire via un serveur web.\n\nPar défaut, la page d'accueil est rendue depuis le fichier `README.md` contenue dans le répertoire. Pour ajouter une autre section, créez un nouveau fichier (par exemple `introduction.md`) puis ajoutez-le dans `_sidebar.md` (par exemple `* [Une introduction](introduction.md)`).\n\n## Développement\n\n- Cloner le dépôt :\n```\ngit clone git@github.com:codegouvfr/docsify-dsfr-template.git\n```\n- Installer les dépendances :\n```\nnpm install\n```\n- Construire les fichiers du livrable dans [`docs`](docs) :\n```\nnpm run build\n```\n- Lancer le serveur pour visualiser les modifications en temps réel (SCSS seulement) :\n```\nnpm run serve-sass\n```\n\n## Enpaquetage\n\nL'empaquetage est automatisé via [`release.yml`](.github/workflows/release.yml), qui crée une *Release* contenant l'archive des fichiers nécessaires à partir d'un *tag*.\n\nCe *workfow* nécessite un [secret de dépôt](https://docs.github.com/fr/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository) `GH_TOKEN` (peut être par exemple généré depuis un compte générique qui a un accès en écriture au dépôt), correspondant à un [token d'accès classique](https://docs.github.com/fr/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#cr%C3%A9ation-dun-personal-access-token-classic), nécessitant le scope `repo`.\n\nIl s'exécute automatiquement à l'envoi d'un *tag* qui correspond à un numéro de version (ex. `v.1.0.1`) :\n```\nnpm version 1.0.1\ngit push\n```\n\n## Exemples et réutilisations\n\n- https://codegouvfr.github.io/sill-docs/\n- https://code.gouv.fr/documentation/#/\n\n## Licence\n\nCe dépôt est publié sous licence [MIT](LICENSE.md).\n","funding_links":[],"categories":["HTML"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodegouvfr%2Fdocsify-dsfr-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodegouvfr%2Fdocsify-dsfr-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodegouvfr%2Fdocsify-dsfr-template/lists"}