MkDocs

Architecture des dossiers

Tout se trouve dans /opt/mkdocs/ipv5_wiki il est accessible au groupe adm.

Dans ce repertoire nous trouvons le fichier mkdocs.yml, il contient les infos génériques (nom du site, theme, auteurs, navigation, repertoire de build, ...).

Il y a ensuite le repertoire docs contenant tous les fichiers MarkDown.

Créer une nouvelle page

Il suffit de créer un fichier .md dans le repertoire docs et le structurer à la maniére d'un fichier MarkDown.

Ensuite il faut éditer le fichier mkdocs.yml pour l'ajouter dans la partie nav.

Génerer la doc

Tout d'abord il faut activer le venv

$ . /opt/mkdocs/venv_mkdocs/bin/activate

Ensuite il faut lancer la buil

(venve_mkdocs)$ cd /opt/mkdocs/ipv5_wiki && mkdocs build

Les fichiers sont créés automatiquement dans le repertoire accessible à nginx /var/www/ipv5.fr/docs