Ce dépôt permet de générer un répertoire de documentation utilisant le système de design de l'État (DSFR).
Le rendu de la documentation utilise docsify.
- Docsify génère les pages web directement depuis des fichiers Markdown. Il suffit d'ajouter un fichier
.mdet de l'intégrer au menu de gauche via_sidebar.mdpour qu'il apparaisse dans le menu. - Le rendu visuel est configurable via les options disponibles pour docsify.
- Le rendu au DSFR est à jour avec la dernière version stable.
- Téléchargez l'archive
docsfr-[latest].tar.gzlié à la dernière version du dépôt. - Adaptez le fichier
index.htmlselon vos besoins. En particulier, si vous souhaitez que votre documentation pointe vers un dépôt Git, décommentez la ligne du script renseignant lerepo. - Commencez à rédiger votre documentation en Markdown dans ce répertoire.
- Publiez ce répertoire via un serveur web.
Par 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)).
- Cloner le dépôt :
git clone [email protected]:codegouvfr/docsify-dsfr-template.git
- Installer les dépendances :
npm install
- Construire les fichiers du livrable dans
docs:
npm run build
- Lancer le serveur pour visualiser les modifications en temps réel (SCSS seulement) :
npm run serve-sass
L'empaquetage est automatisé via release.yml, qui crée une Release contenant l'archive des fichiers nécessaires à partir d'un tag.
Ce workfow nécessite un secret de dépôt 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, nécessitant le scope repo.
Il s'exécute automatiquement à l'envoi d'un tag qui correspond à un numéro de version (ex. v.1.0.1) :
npm version 1.0.1
git push
Ce dépôt est publié sous licence MIT.