MkDocs

Accesso

• Apri: http://SERVER_IP

Modificare e pubblicare contenuti

1. Aggiungi o modifica i file Markdown: /opt/mkdocs/docs

2. Se aggiungi o rinomini pagine, aggiorna /opt/mkdocs/mkdocs.yml for navigation.

3. Ricostruisci il sito:

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

Nginx serve i file generati da: /opt/mkdocs/site

Dopo la ricostruzione non serve riavviare Nginx.

Percorsi importanti

• Progetto: /opt/mkdocs
• Contenuto: /opt/mkdocs/docs
• Configurazione: /opt/mkdocs/mkdocs.yml
• Output della build: /opt/mkdocs/site
• Ambiente virtuale Python: /opt/mkdocs/venv
• Eseguibile di MkDocs: /opt/mkdocs/venv/bin/mkdocs
• Configurazione Nginx: /etc/nginx/sites-available/mkdocs.conf

Dominio e HTTPS

1. Fai puntare il tuo dominio all'indirizzo IP del server.

2. Modifica la configurazione di Nginx e sostituisci server_name _; con il tuo dominio (per esempio, server_name <YOUR_DOMAIN>;):

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

3. Verifica la configurazione:

nginx -t

4. Installa Certbot:

apt install -y certbot python3-certbot-nginx

5. Genera un certificato Let's Encrypt:

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

6. Ricarica Nginx:

systemctl reload nginx

7. Aggiorna l'URL del sito MkDocs: sostituisci site_url: 'http://<SERVER_IP>/' con site_url: 'https://<YOUR_DOMAIN>/' in /opt/mkdocs/mkdocs.yml.

8. Ricostruisci il sito:

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

9. Apri il browser e vai a: https://<YOUR_DOMAIN>

Note

• Le modifiche in Markdown devono essere ricostruite prima di comparire sul sito pubblico.
• Nginx serves the generated files from /opt/mkdocs/site.
• Modifica mkdocs.yml e la configurazione del progetto secondo le tue preferenze.