Skip to content

Comment mettre à jour la documentation

Ce site utilise MkDocs et GitLab Pages.

Modifier une page existante

  1. Ouvrir le projet sur GitLab
  2. Aller dans le dossier docs
  3. Ouvrir le fichier .md (par exemple index.md)
  4. Faire les modifications
  5. Écrire un message de commit
  6. Valider (Commit changes)
  7. Attendre la fin du pipeline (CI)

Ajouter une nouvelle page

  1. Créer un nouveau fichier dans docs (ex: nouvelle-page.md)
  2. Écrire le contenu en Markdown
  3. Ajouter la page dans mkdocs.yml (menu / navigation)
  4. Faire un commit
  5. Attendre la fin du pipeline

Publication

La publication est automatique avec GitLab Pages.
Chaque commit sur la branche main met à jour le site.