---

📚 Docusaurus – Documentation centralisée

Un dépôt qui centralise plusieurs documentations techniques et projets, organisé avec Docusaurus 2. Ce dépôt fournit une arborescence hiérarchique de docs, des environnements prêts à l’emploi via Docker Compose, et plusieurs plugins personnalisés.

---

🗂️ Hiérarchie du projet

Docusaurus/
├── docs/                # Documentation organisée par projets
│   ├── project-1/       # Exemple : projet technique A
│   │   ├── intro.md
│   │   └── ...
│   ├── project-2/       # Exemple : projet technique B
│   └── ...
├── src/                 # Code source spécifique à Docusaurus (custom components, pages)
├── static/              # Fichiers statiques (images, logos…)
├── docusaurus.config.js # Configuration principale
├── sidebars.js          # Définition de la navigation et hiérarchie
├── package.json         # Dépendances Node.js
├── docker-compose.yml   # Stack Docker (dev/prod)
└── ...

• Chaque documentation doit être contenue dans un sous-dossier de docs/.
• La hiérarchie est reflétée automatiquement dans la sidebar (configurée dans sidebars.js).
• Les ressources statiques (images, fichiers téléchargeables) doivent aller dans static/.

---

🚀 Lancer le projet

🔹 Mode développement (Docker)

Le mode dev permet le hot-reload des docs et composants.

docker compose --profile dev up

👉 L’interface est alors disponible sur : http://localhost:3000

Pour arrêter :

docker compose --profile dev down

🔹 Mode développement (local Node.js)

Si tu veux travailler sans Docker :

# Installer les dépendances
npm install
# ou
yarn install

# Lancer en mode dev
npm run start
# ou
yarn start

---

🔹 Mode production (Docker)

Pour générer et servir le site statique optimisé :

docker compose --profile prod up --build

👉 Accessible sur : http://localhost:8080

---

⚙️ Spécificités et plugins custom

Le projet utilise plusieurs plugins et thèmes pour enrichir Docusaurus.

📦 Plugins installés

• @docusaurus/plugin-content-docs → gestion des docs.
• @docusaurus/plugin-content-blog → si tu ajoutes un blog.
• @docusaurus/plugin-sitemap → génération d’un sitemap.
• docusaurus-plugin-panzoom → zoom et pan sur les schémas/diagrammes (⚠️ voir notes ci-dessous).
• Mermaid plugin → support des diagrammes Mermaid.

🔧 Personnalisation

• Docker Compose avec profils : permet de lancer facilement le site en dev (3000) ou en prod (8080).
• Hot-reload activé : en dev, toute modification dans docs/ recharge automatiquement la page.
• Panzoom : utilisé pour zoomer sur les diagrammes (notamment Mermaid).
• Mermaid : permet de documenter avec des diagrammes séquence/flowchart directement en Markdown.

---

➕ Ajouter une documentation

1. Créer un nouveau dossier dans docs/ :

   mkdir docs/mon-projet
   echo "# Introduction" > docs/mon-projet/intro.md

2. Déclarer le dossier dans sidebars.js si besoin d’un ordre spécifique.

3. Relancer le projet en dev (docker compose --profile dev up).

---

🤝 Contribution

• Respecter la hiérarchie docs/<projet>/.

• Toujours tester en local (yarn start ou Docker dev) avant commit.

• Ajouter les nouveaux plugins via :

  npm install <plugin>
  # ou
  yarn add <plugin>

• Mettre à jour docusaurus.config.js pour l’activer.

---

🔗 Liens utiles

• 📖 Documentation officielle Docusaurus
• 🔌 Liste des plugins Docusaurus
• 🔍 Panzoom plugin
• 🖊️ Mermaid pour Docusaurus

---

📜 Licence

Projet sous licence MIT. Développé et maintenu par Guilhèm Bonnet.

---