MkDocs

Acceso

• Abre: http://SERVER_IP

Editar y publicar contenido

1. Añade o edita archivos Markdown: /opt/mkdocs/docs

2. Si añades o cambias el nombre de páginas, actualiza /opt/mkdocs/mkdocs.yml for navigation.

3. Reconstruye el sitio:

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

Nginx sirve los archivos generados desde: /opt/mkdocs/site

No hace falta reiniciar Nginx después de reconstruir.

Rutas importantes

• Proyecto: /opt/mkdocs
• Contenido: /opt/mkdocs/docs
• Configuración: /opt/mkdocs/mkdocs.yml
• Salida de la compilación: /opt/mkdocs/site
• Entorno virtual de Python: /opt/mkdocs/venv
• Ejecutable de MkDocs: /opt/mkdocs/venv/bin/mkdocs
• Configuración de Nginx: /etc/nginx/sites-available/mkdocs.conf

Dominio y HTTPS

1. Apunta tu dominio a la dirección IP del servidor.

2. Edita la configuración de Nginx y sustituye server_name _; por tu dominio (por ejemplo, server_name <YOUR_DOMAIN>;):

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

3. Prueba la configuración:

nginx -t

4. Instala Certbot:

apt install -y certbot python3-certbot-nginx

5. Genera un certificado de Let's Encrypt:

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

6. Recarga Nginx:

systemctl reload nginx

7. Actualiza la URL del sitio MkDocs: sustituye site_url: 'http://<SERVER_IP>/' por site_url: 'https://<YOUR_DOMAIN>/' in /opt/mkdocs/mkdocs.yml.

8. Reconstruye el sitio:

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

9. Abre tu navegador y visita: https://<YOUR_DOMAIN>

Notas

• Los cambios en Markdown deben reconstruirse antes de aparecer en el sitio público.
• Nginx serves the generated files from /opt/mkdocs/site.
• Cambia mkdocs.yml y la configuración del proyecto según tus preferencias.