Skip to content

🚀 Déploiement de MkDocs avec Docker Compose

MkDocs est un générateur de documentation statique simple et open-source, idéal pour créer et maintenir une documentation bien organisée.

✅ Prérequis

1️⃣ Configuration

Le service wiki utilise une image construite à partir d’un Dockerfile. Le projet MkDocs est monté en volume pour permettre la modification directe des fichiers source.

Composants principaux Description
wiki Service MkDocs basé sur une image Docker construite localement
Volume Monte le dossier ./mkdocs dans /app du conteneur pour persister et modifier la doc

2️⃣ Exemple d’arborescence projet

/mkdocs
├── docs/
│   ├── index.md
│   ├── about.md
│   └── ...
├── mkdocs.yml
└── ...

3️⃣ Exemple de docker-compose.yml

version: '3.8'

services:
  wiki:
    build:
      context: .
      dockerfile: Dockerfile
    volumes:
      - ./mkdocs:/app
    working_dir: /app
    restart: unless-stopped

4️⃣ Démarrage

  1. Construisez l’image Docker :
docker-compose build
  1. Lancez le service en arrière-plan :
docker-compose up -d
  1. Vérifiez que le conteneur tourne :
docker-compose ps

5️⃣ Modifier la documentation

  • Ajoutez/modifiez vos fichiers Markdown dans ./mkdocs/docs/.
  • Organisez la navigation dans mkdocs.yml :
site_name: My Wiki
nav:
  - Accueil: index.md
  - A propos: about.md
  - Catégorie 1:
      - Page 1: category1/page1.md
      - Page 2: category1/page2.md
theme:
  name: material

6️⃣ Accès à l’application

  • Ouvrez votre navigateur à :
http://localhost:<port>

Remplacez <port> par celui défini dans votre configuration Docker (à ajouter dans docker-compose.yml si nécessaire).

7️⃣ Gestion du service

Action Commande
Voir les logs docker-compose logs -f
Redémarrer docker-compose restart
Arrêter et supprimer docker-compose down

🔚 Conclusion

Ce projet permet de déployer simplement une documentation statique avec MkDocs dans un environnement Docker, facilitant la maintenance et la personnalisation de votre wiki.