Construir sitios de documentación técnica versionada con búsqueda y navegación usando Material for MkDocs
Usa Material for MkDocs para convertir documentación en Markdown en un sitio estático con búsqueda, navegación y configuración lista para producción.
Requisitos previos
Python, pip o Docker, MkDocs, Material for MkDocs, archivos de documentación en Markdown
Instalación
Usa la ruta de instalación estándar o configura tu entorno según corresponda:
- Hazlo tuyo: cambia colores, fuentes, idioma, íconos, logotipo y más con
- pip install mkdocs-material
Requisitos y consideraciones del proyecto upstream:
- alt="Python Package Index"
- <img
- src="https://img.shields.io/docker/pulls/squidfunk/mkdocs-material"
Notas de uso básico o inicio rápido:
-
Material for MkDocs se puede instalar con pip:
-
sh
-
Agrega las siguientes líneas a mkdocs.yml:
-
Extraído de la documentación upstream: https://raw.githubusercontent.com/squidfunk/mkdocs-material/HEAD/README.md