Troubleshooting — Errores Comunes y Soluciones¶
Este documento recoge problemas y soluciones comunes al trabajar con la documentación y el sitio MkDocs.
Error: "Config value 'plugins': The 'minify' plugin is not installed"¶
- Causa: El plugin
mkdocs-minify-pluginno está instalado en el entorno. - Solución:
- Instalar localmente:
pip install mkdocs-minify-plugin
minify en mkdocs.yml si no estás listo para instalarlo.
Problemas de rutas de assets (logo, css, js)¶
- Causa: Rutas relativas que no existen en
docs/. - Solución: Asegúrate de que los archivos referenciados en
mkdocs.ymlexistan endocs/(por ejemplodocs/images/logo.png,docs/stylesheets/extra.css).
Problemas de Mermaid (diagramas no renderizados)¶
- Causa: Errores de sintaxis o plugins faltantes.
- Solución:
- Ejecutar el script de verificación (si existe) o revisar la consola del navegador.
- Usa
internal/mermaid/diagramas_guia.mdpara revisar ejemplos yinternal/mermaid/tools/check_diagrams.pypara verificaciones automáticas.
Enlaces rotos¶
- Solución: Ejecuta
mkdocs buildy revisa las advertencias/errores. Usa comprobadores de enlaces en CI.
Otros¶
- Reporta fallos en Issues o crea una PR con un fix y referencia
TODO.mdpara añadir nuevas tareas o posts de documentación.