Aller au contenu

Écrire de la documentation

Guide pour contribuer à la documentation

Structure

Chaque document doit suivre cette structure:

  1. Titre H1 unique
  2. Citation d'introduction
  3. Table des matières (auto-générée)
  4. Sections principales
  5. Footer avec metadata

Exemple de template

Voir: templates/

MkDocs

La documentation utilise MkDocs avec le thème Material.

Commandes locales

```bash

Serveur de développement

mkdocs serve

Build

mkdocs build

Déploiement

mkdocs gh-deploy ```


Document créé lors de la réorganisation