MkDocs

Zugriff

• Öffnen: http://SERVER_IP

Inhalte bearbeiten und veröffentlichen

1. Fügen Sie Markdown-Dateien hinzu oder bearbeiten Sie sie: /opt/mkdocs/docs

2. Wenn Sie Seiten hinzufügen oder umbenennen, aktualisieren Sie /opt/mkdocs/mkdocs.yml for navigation.

3. Bauen Sie die Website neu:

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

Nginx liefert die generierten Dateien aus: /opt/mkdocs/site

Nach dem Neubau ist kein Neustart von Nginx nötig.

Wichtige Pfade

• Projekt: /opt/mkdocs
• Inhalt: /opt/mkdocs/docs
• Konfiguration: /opt/mkdocs/mkdocs.yml
• Build-Ausgabe: /opt/mkdocs/site
• Python-Virtualenv: /opt/mkdocs/venv
• MkDocs-Programmdatei: /opt/mkdocs/venv/bin/mkdocs
• Nginx-Konfiguration: /etc/nginx/sites-available/mkdocs.conf

Domain und HTTPS

1. Richten Sie Ihre Domain auf die IP-Adresse des Servers.

2. Bearbeiten Sie die Nginx-Konfiguration und ersetzen Sie server_name _; durch Ihre Domain (z. B. server_name <YOUR_DOMAIN>;):

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

3. Testen Sie die Konfiguration:

nginx -t

4. Installieren Sie Certbot:

apt install -y certbot python3-certbot-nginx

5. Erzeugen Sie ein Let's-Encrypt-Zertifikat:

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

6. Laden Sie Nginx neu:

systemctl reload nginx

7. Aktualisieren Sie die MkDocs-Website-URL: ersetzen Sie site_url: 'http://<SERVER_IP>/' durch site_url: 'https://<YOUR_DOMAIN>/' in /opt/mkdocs/mkdocs.yml.

8. Bauen Sie die Website neu:

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

9. Öffnen Sie Ihren Browser und besuchen Sie: https://<YOUR_DOMAIN>

Hinweise

• Markdown-Änderungen müssen neu gebaut werden, bevor sie auf der öffentlichen Website erscheinen.
• Nginx serves the generated files from /opt/mkdocs/site.
• Ändern Sie mkdocs.yml und die Projektkonfiguration nach Ihren Wünschen an.