Le site web de la documentation est construit à l'aide de Docusaurus 2, un générateur de site statique, basé sur nodejs.
Le contenu, en markdown (avec possibilité d'inclure du html) est situé dans le dossier /docs.
Les images sont à stocker dans le dossier /static/img/. Pour linker une image dans le contenu markdown, il faut utiliser le chemin /img/....
L'adresse de la documentation est celle-ci : https://www.mesonet.fr/documentation/user-documentation/
nodejs >=16.14: https://nodejs.org/en/download/package-manageryarnounpminstallés sur la machine cible.
- On clone ce dépôt :
git clone git@github.com:MesoNET/user-documentation.git - on installe docusaurus :
cd mesodoc && yarn installoucd mesodoc && npm install - On édite ce que l'on souhaite
- On construit le site et lance un serveur web localement pour le prévisualiser :
yarn serveounpm run start