MkDocs¶
Objectif¶
Publier la documentation du Homelab en HTML à partir des fichiers Markdown du dépôt Git.
Accès¶
- URL : https://docs.hello-group-sas.com
- Proxy : Caddy
- Port interne : 8000
Configuration¶
| Élément | Emplacement |
|---|---|
| Compose | compose/mkdocs/compose.yaml |
| Variables | env/mkdocs/.env |
| Configuration | data/mkdocs/mkdocs.yml |
| Documentation | docs/ |
Docker¶
| Paramètre | Valeur |
|---|---|
| Image | squidfunk/mkdocs-material:9.7.6 |
| Conteneur | mkdocs |
| Réseau | homelab |
| Restart | unless-stopped |
Fonctionnement¶
Le conteneur sert automatiquement la documentation présente dans :
/opt/homelab/docs
Le rendu est réalisé avec le thème Material for MkDocs.
La publication est assurée par Caddy via :
https://docs.hello-group-sas.com
Dépendances¶
- Caddy
- Documentation Markdown (
docs/)
Sauvegarde¶
Aucune donnée métier.
À sauvegarder :
data/mkdocs/mkdocs.yml
La documentation est sauvegardée avec le dépôt Git.
Exploitation¶
Démarrer¶
docker compose -f compose/mkdocs/compose.yaml up -d
Arrêter¶
docker compose -f compose/mkdocs/compose.yaml down
Redémarrer¶
docker compose -f compose/mkdocs/compose.yaml restart
Logs¶
docker logs -f mkdocs
Maintenance¶
Après modification d'un fichier Markdown, la documentation est reconstruite automatiquement.
En cas de modification de mkdocs.yml, redémarrer le service :
docker compose -f compose/mkdocs/compose.yaml restart