| Tutoriales | MkDocs |
Tutorial de MkDocs
MkDocs es una herramienta estática para crear sitios de documentación usando Markdown.
Está diseñada para ser rápida, sencilla y enfocada en la lectura, ideal para proyectos de software, cursos y guías técnicas.
Para obtener la documentación oficial, visite mkdocs.org.
Instalación
Asegúrate de tener Python y pip instalados. Luego, en la terminal ejecuta:
pip install mkdocs
Puedes verificar la instalación con:
mkdocs --version
Comandos básicos
mkdocs new [nombre-proyecto]— Crea un nuevo proyecto de documentación.mkdocs serve— Inicia un servidor local con recarga en vivo.mkdocs build— Genera el sitio estático listo para publicar.mkdocs -h— Muestra la ayuda con todos los comandos disponibles.
Organización del proyecto
La estructura típica de un proyecto MkDocs es:
mkdocs.yml # Archivo de configuración principal
docs/
index.md # Página principal (homepage)
... # Otras páginas Markdown, imágenes y archivos
Personalización
MkDocs permite cambiar la apariencia y funcionalidad del sitio mediante:
- Temas: por ejemplo, Material for MkDocs.
- Overrides: plantillas HTML personalizadas.
- Extensiones Markdown: para añadir más sintaxis.
- Plugins: para funcionalidades adicionales (búsqueda avanzada, SEO, etc.).
Recursos adicionales en este curso
Enlaces útiles
| Tutoriales | MkDocs |