1.8 KiB
Comment travailler sur le thème de la documentation
[!NOTE] Un rappel rapide que vous n'avez pas besoin de configurer quoi que ce soit pour travailler sur le contenu du site de documentation.
Pour travailler sur les directives de contribution, vous pouvez modifier ou ajouter des fichiers dans le répertoire
docs
disponible ici. Lorsque vos modifications seront fusionnées, elles seront mises à disposition automatiquement sur le site de documentation.
Structure du site web de la documentation
Le site est généré en utilisant docsify
, et servi en utilisant des pages GitHub.
Généralement, vous n'aurez pas besoin de modifier une configuration ou de construire le site localement. Au cas où vous seriez intéressé, voici comment ça marche :
- La source de la page d'accueil pour ce site est disponible dans
docs/index.html
. - Nous servons ce fichier comme SPA en utilisant
docsify
et GitHub Pages. - Le script
docsify
génère le contenu des fichiersmarkdown
dans le répertoiredocs
à la demande. - La page d'accueil est générée à partir de la
_coverpage.md
. - la navigation dans la barre latérale est générée depuis
_sidebar.md
.
Servir le site de documentation localement
Cloner le camp de code libre:
git clone https://github.com/freeCodeCamp/freeCodeCamp.git
docsify serve docs
Installer docsify
:
npm install -g docsify
et servir le répertoire /docs
docsify serve docs
Alternativement, si vous avez installé freeCodeCamp localement (voir le guide de configuration locale), nous regroupons le CLI avec les outils de développement pour que vous puissiez exécuter docs:serve
depuis la racine du dépôt.