Aller au contenu principal

Gérer la documentation Docusaurus

Ce guide explique pas à pas comment ajouter, modifier et supprimer des pages de documentation sur ce site.

Consultez aussi le glossaire Docusaurus pour retrouver rapidement les termes techniques utilisés dans ces guides.

Prérequis​

Avant de commencer, assurez-vous de :

  1. Avoir cloné le dépôt et installé les dépendances (npm install dans devs/web-site/)
  2. Lancer le serveur local pour prévisualiser vos changements : npm run start
  3. Le site s'ouvre automatiquement sur http://localhost:3000

Les deux fichiers clés​

FichierRôle
docs/**/*.mdContenu des pages
sidebars.jsStructure et ordre de la sidebar

Important : Sur ce projet la sidebar est gérée manuellement. Ajouter ou supprimer un fichier .md ne suffit pas — il faut aussi mettre à jour sidebars.js.

Éléments systématiques à vérifier après chaque modification​

  • Navbar (Docs, Contact, Theme Toggle)
  • Sidebar gauche (catégories + pages)
  • Bouton List docs dans le breadcrumb
  • Contenu central (titres, liens, tableaux, blocs)
  • TOC droite (liens d'ancre valides)
  • Pagination Prev/Next
  • Footer (liens docs et références)

Guides disponibles​

Procédures​

Références​

Vues interactives​