MkDocs

MkDocs permet de générer un site web statique de documentation à partir de fichiers Markdown (comme ce site web).

Installation

Le paquet mkdocs existe sous Debian mais est obsolète et incomplet. Nous allons plutôt configurer un environnement virtuel Python spécifique pour MkDocs :

$ python3 -m venv ~/.python-venv/mkdocs
$ .python-venv/mkdocs/bin/pip install mkdocs mkdocs-i18n

Et l'ajouter au PATH :

# PATH MkDocs (via pip)
export PATH="$PATH:~/.python-venv/mkdocs/bin"

Commandes

• mkdocs new [nom_du_projet] - Créé un nouveau projet
• mkdocs serve - Démarre le serveur pour voir les modifications en temps réel dans le navigateur
• mkdocs build - Construit la documentation
• mkdocs -h - Affiche l'aide

Documentation et ressources

• Documentation de MkDocs : https://www.mkdocs.org/user-guide/