Documentación · Estático · Markdown · Versionado
MkDocs — Generador de documentación¶
La herramienta con la que se escribe y publica esta documentación. Archivos de texto plano en Markdown, sin base de datos, versionados junto al código en Forgejo.
Como usuario¶
No se interactúa directamente. Lees la documentación en el navegador. Todo lo que ves en docs.sc está generado por MkDocs.
Integración con otros servicios de SmallCountry¶
| Servicio | Relación |
|---|---|
| Forgejo | El código fuente de la documentación vive en Forgejo |
| Forgejo Actions | CI/CD (integración y despliegue continuo) reconstruye el sitio automáticamente en cada commit |
| Caddy | Serviría el sitio generado |
Para el administrador (diseño previsto)
| LXC (contenedor ligero de Proxmox) | 141 (compartido con Joplin Server) |
| IP | 10.10.20.141 |
| Tier | B |
| Impacto | 🟢 Bajo |
Sin ZFS propio — los archivos fuente están en Forgejo y el sitio generado en /opt/mkdocs/site/. Docker: squidfunk/mkdocs-material. Healthcheck: curl https://docs.sc. Backup: código fuente versionado en Forgejo + PBS.
Para el arquitecto (diseño previsto)
vmbr2. Puerto: 8000 (dev server). Se construye con mkdocs build y el resultado se sirve estáticamente. El CI/CD de Forgejo Actions ejecuta mkdocs build --clean en cada push a la rama principal. Playbook: deploy-mkdocs.yml (compartido con Joplin). Tema: Material for MkDocs.