Skythrew / papillon-docs

Documentation du projet Papillon (avec Material for MkDocs)

Documentation de Papillon

Vous pouvez contribuer à la documentation de Papillon via ce dépôt GitHub.

Ajouter des pages

Le contenu du site est écrit en Markdown et se trouve dans /docs.

Le site web est ensuite généré par MkDocs avec le modèle Material for MkDocs.

Vous pouvez vous aider de la référence de Material for MkDocs.

Forkez ce dépôt, faites vos propositions et envoyez une pull request. On l'acceptera au plus vite.

Compiler localement

Pour tester vos changements sur votre ordinateur avant l'envoi:

1. Installez Python
   • Sur Windows, cochez l'option pour ajouter Python au PATH lors de l'installation
2. Clonez le référentiel et ouvrez un terminal dans le dossier du clone
3. Installez les outils nécessaires avec:

pip3 install -r requirements.txt

4. Démarrez un serveur compilant automatiquement les modifications :

mkdocs serve