MkDocs

Accès

• Ouvrez : http://SERVER_IP

Modifier et publier du contenu

1. Ajoutez ou modifiez des fichiers Markdown : /opt/mkdocs/docs

2. Si vous ajoutez ou renommez des pages, mettez à jour /opt/mkdocs/mkdocs.yml for navigation.

3. Reconstruisez le site :

/opt/mkdocs/venv/bin/mkdocs build --clean \
  --config-file /opt/mkdocs/mkdocs.yml \
  --site-dir /opt/mkdocs/site

Nginx sert les fichiers générés depuis : /opt/mkdocs/site

Aucun redémarrage de Nginx n'est nécessaire après une reconstruction.

Chemins importants

• Projet : /opt/mkdocs
• Contenu : /opt/mkdocs/docs
• Configuration : /opt/mkdocs/mkdocs.yml
• Sortie de build : /opt/mkdocs/site
• Environnement virtuel Python : /opt/mkdocs/venv
• Exécutable MkDocs : /opt/mkdocs/venv/bin/mkdocs
• Configuration Nginx : /etc/nginx/sites-available/mkdocs.conf

Domaine et HTTPS

1. Faites pointer votre domaine vers l'adresse IP du serveur.

2. Modifiez la configuration Nginx et remplacez server_name _; par votre domaine (par exemple, server_name <YOUR_DOMAIN>;):

vim /etc/nginx/sites-available/mkdocs.conf

3. Testez la configuration :

nginx -t

4. Installez Certbot :

apt install -y certbot python3-certbot-nginx

5. Générez un certificat Let's Encrypt :

certbot --nginx --non-interactive --agree-tos --email <YOUR_EMAIL> -d <YOUR_DOMAIN>

6. Rechargez Nginx :

systemctl reload nginx

7. Mettez à jour l'URL du site MkDocs : remplacez site_url: 'http://<SERVER_IP>/' par site_url: 'https://<YOUR_DOMAIN>/' in /opt/mkdocs/mkdocs.yml.

8. Reconstruisez le site :

/opt/mkdocs/venv/bin/mkdocs build --clean \
  --config-file /opt/mkdocs/mkdocs.yml \
  --site-dir /opt/mkdocs/site

9. Ouvrez votre navigateur et allez sur : https://<YOUR_DOMAIN>

Remarques

• Les modifications Markdown doivent être reconstruites avant d'apparaître sur le site public.
• Nginx serves the generated files from /opt/mkdocs/site.
• Modifiez mkdocs.yml et la configuration du projet selon vos préférences.