Repolode
squidfunk

squidfunk/mkdocs-material

Un tema Material Design para MkDocs que convierte archivos Markdown en un sitio de documentación estático, adaptable y con búsqueda.

Estrellas
27,581
Forks
4,150
Issues abiertos
1
Último commit
hace 5 días

¿Qué es?

Material for MkDocs es un tema para MkDocs, un generador de sitios estáticos para documentación de proyectos escrita en Markdown. A partir de archivos Markdown, genera un sitio con estilos, navegación, búsqueda y diseños que se adaptan a pantallas de escritorio, tabletas y móviles. Se instala como paquete de pip y se activa con unas pocas líneas en mkdocs.yml.

El tema se puede configurar sin escribir HTML, CSS ni JavaScript. Los colores, las fuentes, los iconos, el logo y el idioma de la interfaz (más de 60 idiomas) se definen mediante la configuración, y el proyecto ofrece puntos de extensión para personalizarlo aún más. El sitio se genera como archivos estáticos, por lo que el resultado se puede alojar en cualquier hosting estático, y el propietario mantiene el control tanto del contenido de origen como del generado.

El proyecto tiene licencia MIT y está desarrollado en Python. Numerosos proyectos de código abierto y empresas lo usan para sus sitios de documentación.

Funciones clave

  • 01Escribe documentación en Markdown sin necesidad de HTML, CSS ni JavaScript.
  • 02Diseño adaptable a pantallas de escritorio, tabletas y móviles.
  • 03Búsqueda y navegación integradas en los sitios estáticos generados.
  • 04Personaliza colores, fuentes, iconos, logo e idioma mediante la configuración.
  • 05Compatible con más de 60 idiomas de interfaz.

Casos de uso

  • Crear un sitio de documentación para una biblioteca o herramienta de código abierto.
  • Publicar documentación interna sobre productos o ingeniería para una empresa.
  • Crear un sitio de documentación multilingüe con un diseño coherente.

Inicio rápido

  1. 1

    Instala Material for MkDocs con pip

    pip install mkdocs-material
  2. 2

    Añade el tema a mkdocs.yml

    theme: name: material

Antes de usarlo

  • Requiere Python y la cadena de herramientas de MkDocs, por lo que solo es útil para sitios de documentación.

Temas

Preguntas frecuentes

¿Qué es mkdocs-material?
Un tema Material Design para MkDocs que convierte archivos Markdown en un sitio de documentación estático, adaptable y con búsqueda. Material for MkDocs es un tema para MkDocs, un generador de sitios estáticos para documentación de proyectos escrita en Markdown. A partir de archivos Markdown, genera un sitio con estilos, navegación, búsqueda y diseños que se adaptan a pantallas de escritorio, tabletas y móviles. Se instala como paquete de pip y se activa con unas pocas líneas en mkdocs.yml.
¿mkdocs-material es gratuito? ¿Qué licencia tiene?
mkdocs-material es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿mkdocs-material sigue mantenido?
Mantenimiento activo. El último commit de mkdocs-material fue el 17 oct 2026.
¿Para qué puedo usar mkdocs-material?
Crear un sitio de documentación para una biblioteca o herramienta de código abierto. Publicar documentación interna sobre productos o ingeniería para una empresa. Crear un sitio de documentación multilingüe con un diseño coherente.
¿Cómo se instala mkdocs-material?
Instala Material for MkDocs con pip: pip install mkdocs-material Añade el tema a mkdocs.yml: theme: name: material
¿Dónde consigo mkdocs-material?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/squidfunk/mkdocs-material

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados