MkDocs (Générateur de documentation)
Environnement
- Ubuntu 18.04
Installation
Créer un utilisateur user :
useradd -m user
passwd user
Configurer l'accès SSH à clé privée
Installer pip :
apt install python3-pip
Installer mkdocs et les thèmes ReadTheDocs-DropDown et WindMill (/!\ avec un compte utilisateur) :
pip3 install mkdocs
pip3 install mkdocs-windmill
pip3 install mkdocs-ivory
Utilisation
Créer un nouveau projet :
cd /home/user
/home/user/.local/bin/mkdocs new mon_projet
Démarrer le serveur :
cd mon_projet
/home/user/.local/bin/mkdocs serve --dev-addr 0.0.0.0:8000 -t windmill
Construire le site statique :
/home/user/.local/bin/mkdocs build -t windmill
Exporter le site vers un serveur Web.
Sources
https://www.mkdocs.org/#installation