Articulo de referencia

MkDocs

{{cite web|title=Release Notes|url=https://www.mkdocs.org/about/release-notes/#version-161-2024-08-30|website=MkDocs}} "},"latest release date":{"wt":"{{Start date and age|2024|...

MkDocs es un generador de sitios estáticos diseñado para crear documentación de proyectos . Está escrito en Python y también se utiliza en otros entornos.

Modo de funcionamiento

MkDocs convierte archivos Markdown en páginas HTML , creando así un sitio web estático que contiene documentación.

Markdown es extensible, y el ecosistema MkDocs explota su naturaleza extensible a través de una serie de extensiones [ 2 ] [ 3 ] que ayudan a generar automáticamente documentación a partir del código fuente, agregar advertencias, escribir notación matemática, insertar notas al pie, resaltar el código fuente, etc.

Temas

MkDocs proporciona dos temas integrados: el tema predeterminado (basado en Bootstrap ) y el tema Read the Docs . Muchos de los temas de terceros disponibles se enumeran en el catálogo oficial, [ 4 ] incluyendo el popular tema Material for MkDocs. [ 5 ]

Historia

La primera versión etiquetada de MkDocs, la versión 0.2, salió el 21 de enero de 2014. [ 6 ]

A principios de 2015, Read the Docs admitía la creación de documentación con MkDocs, además de Sphinx . En preparación para el lanzamiento de la versión 0.12, [ 7 ] MkDocs comenzó a usar Read the Docs para el alojamiento. [ 8 ]

En enero de 2016, MkDocs añadió soporte para temas instalables. [ 9 ] Al mes siguiente, Martin Donath comenzó a desarrollar el tema Material para MkDocs. En los años siguientes, el tema se hizo muy popular y en julio de 2020 el modelo de desarrollo cambió a sponsorware, donde las nuevas funciones se lanzan primero a la versión Insiders y están disponibles públicamente una vez que se alcanzan los objetivos de financiación. [ 10 ]

El tema de Martin Donath se convirtió en un proyecto propio (Material para MkDocs).) y estuvo activo durante casi 10 años. Después de no estar activo durante algún tiempo, Donath anunció que abandonaba el uso de MkDocs debido a limitaciones inherentes y escribió un nuevo motor estático desde cero en un nuevo proyecto llamado Zensical [ 11 ].

En marzo de 2026, tras algunos cambios en la lista de mantenedores, [ 12 ] [ 13 ] [ 14 ] la creadora original de MkDocs (Mia Kimberly Christie - @lovelydinosaur) retomó el control del repositorio y anunció que la versión v2.0 de MkDocs está en desarrollo.

Uso

MkDocs ofrece soporte integrado para la implementación en GitHub Pages. Otras alternativas, como GitLab y Cloudflare Pages, ofrecen soporte nativo para la implementación de sitios MkDocs. [ 15 ] [ 16 ]

Muchas empresas utilizan MkDocs con el tema Material para desplegar su documentación, incluidas Atlassian , [ 17 ] Google , [ 18 ] Microsoft , [ 19 ] y Red Hat . [ 20 ] También es una opción popular entre proyectos de código abierto, como Electron , [ 21 ] Kubernetes , [ 22 ] y WebKit . [ 23 ]

Véase también

Referencias

  1. "Notas de la versión" . MkDocs .
  2. "Extensiones — Documentación de Python-Markdown 3.4.4" . python-markdown.github.io . Consultado el 23 de septiembre de 2023 .
  3. "Extensiones de PyMdown - Documentación de las extensiones de PyMdown" . facelessuser.github.io . Consultado el 23 de septiembre de 2023 .
  4. Catálogo de temas , MkDocs, 23/09/2023 , consultado el 23/09/2023
  5. Donath, Martin. "Material para MkDocs" . squidfunk.github.io . Consultado el 23 de septiembre de 2023 .
  6. "Versión 0.2 · mkdocs/mkdocs" . GitHub . Consultado el 24 de septiembre de 2023 .
  7. "MkDocs 0.12 ya está disponible. Incluye muchas correcciones de errores y algunas funciones nuevas" . X (anteriormente Twitter) . 14 de abril de 2015. Consultado el 24 de septiembre de 2023 .
  8. "mkdocs | Read the Docs" . readthedocs.org . 12 de febrero de 2015. Consultado el 24 de septiembre de 2023 .
  9. "La nueva versión de MkDocs admite temas instalables. Una buena adición al proyecto que te permitirá instalarlos a través de pip" . X (anteriormente Twitter) . 21/01/2016 . Consultado el 24/09/2023 .
  10. Donath, Martin (27-12-2021). "El pasado, el presente y el futuro: material para MkDocs" . squidfunk.github.io . Consultado el 24-09-2023 .
  11. Donath, Martin (2025-11-05). "Zensical - Un generador de sitios estáticos moderno - Material para MkDocs" . squidfunk.github.io . Recuperado el 2026-04-02 .
  12. "El lento colapso de MkDocs" . fpgmaas.com . 22 de marzo de 2026. Consultado el 2 de abril de 2026 .
  13. mkdocs. "Me retiro de MkDocs · mkdocs mkdocs · Discusión #3621" . GitHub . Consultado el 2 de abril de 2026 .
  14. mkdocs. "Mantenimiento · mkdocs mkdocs · Discusión #3677" . GitHub . Consultado el 2 de abril de 2026 .
  15. "Ejemplos de GitLab Pages / mkdocs · GitLab" . GitLab . Consultado el 10 de diciembre de 2023 .
  16. "Implementar un sitio MkDocs · Documentación de Cloudflare Pages" . developers.cloudflare.com . 7 de agosto de 2023. Consultado el 10 de diciembre de 2023 .
  17. "Atlassian DC Helm Charts" . atlassian.github.io . Consultado el 10 de diciembre de 2023 .
  18. "Acompañante" . google.github.io . Consultado el 10 de diciembre de 2023 .
  19. "Code With Engineering Playbook" . microsoft.github.io . Consultado el 10 de diciembre de 2023 .
  20. "Inicio - Documentación de Ansible Lint" . ansible-lint.readthedocs.io . Consultado el 10 de diciembre de 2023 .
  21. "electron-builder" . www.electron.build . Consultado el 10 de diciembre de 2023 .
  22. "Bienvenido - kOps - Operaciones de Kubernetes" . kops.sigs.k8s.io. Consultado el 10 de diciembre de 2023 .
  23. "Documentación de WebKit" . docs.webkit.org . Consultado el 10 de diciembre de 2023 .
  • MkDocsEdita esto en Wikidata
  • Read the Docs es un servidor de documentación colaborativo a gran escala impulsado por Sphinx, MkDocs y Jupyter Book.