mkdocs - Installation sur Debian

Pour ajouter Material for MkDocs à votre serveur web :

Installer MkDocs avec pip :

Assurez-vous que Python et pip sont installés sur votre serveur. Exécutez ceci pour installer MkDocs :

pip install mkdocs

Installez le theme Material for MkDocs :

 pip install mkdocs-material

Créer un nouveau répertoire pour la documentation :

Créez un répertoire séparé pour votre documentation, par exemple, /var/www/docs.

mkdir /var/www/docs

Initialisez un nouveau projet MkDocs dans ce répertoire :

mkdocs new /var/www/docs.

Configurer MkDocs :

Dans le répertoire /var/www/docs, éditez le fichier mkdocs.yml pour configurer votre site de documentation. Définissez le thème sur Material en ajoutant la ligne theme: material dans le fichier mkdocs.yml.

Générer le site de documentation :

Dans votre répertoire de documentation, exécutez mkdocs build. Cela générera le site statique dans le sous-répertoire site.

Configurer Apache pour servir la documentation :

Créer le fichier mkdoks.conf dans le répertoire /etc/apache2/sites-available/ Y inclure ceci (à adapter)

<VirtualHost *:443>
    ServerName mkdocs.fabzh.eu
    DocumentRoot /var/www/mkdocs/site

    SSLEngine on
    Include /etc/letsencrypt/options-ssl-apache.conf

    ErrorLog ${APACHE_LOG_DIR}/mkdocs_error.log
    CustomLog ${APACHE_LOG_DIR}/mkdocs_access.log combined

    <Directory /var/www/mkdocs/site>
        Options Indexes FollowSymLinks
        AllowOverride All
        Require all granted
    </Directory>
        SSLCertificateFile /etc/letsencrypt/live/fabzh.eu/fullchain.pem
SSLCertificateKeyFile /etc/letsencrypt/live/fabzh.eu/privkey.pem
</VirtualHost>

Demander à Apache d'activer le site

a2ensite mkdocs.conf

Redémarrer Apache :

systemctl restart apache2.service

Il faudra ensuite créer l'entrée de type A dans la zone DNS de votre registrar pour le site, ici nommé "mkdocs.fabzh.eu", mais ceci est une autre histoire :)