MkDocs
MkDocs es una herramienta desarrollada en Python para generar sitios de documentación estática basados en archivos Markdown.
Visión general
MkDocs es una herramienta muy popular con una gran comunidad. Tiene varios temas para crear sitios web; varios plugins para ampliar la funcionalidad básica del programa y una documentación fácil de entender.
MkDocs es un proyecto de código abierto desarrollado en Python.
La Aplicación usa el procesador Markdown Python-Markdown que proporciona muy buen soporte para elementos de sintaxis básica, sin embargo, la compatibilidad con los elementos de sintaxis extendida deja un poco que desear.
Vale la pena señalar que, como MkDocs usa Python-Markdown, es posible activar extensiones adicionales para cambiar el comportamiento del analizador, haga clic aquí para ver una lista de extensiones disponibles y compatibles con Python-Markdown.
Puede encontrar más información en el sitio web oficial de MkDocs https://www.mkdocs.org/.
Usando Admonitions en MkDocs
La extensión Admonitions le permite mostrar a los usuarios mensajes estilizados en su página en sitios web creados con MkDocs.
Para obtener más información y ejemplos, consulte esta página en GitHub.
Soporte para Markdown en MkDocs
La Tabla 1.1 presenta los elementos Markdown compatibles con MkDocs.
| Elemento | Soporte | Información |
|---|---|---|
| Títulos | Sí | |
| Párrafos | Sí | |
| Saltos de línea | Sí | |
| Negrita | Sí | |
| Itálico | Sí | |
| Blockquote | Sí | |
| Listas ordenadas | Sí | |
| Listas desordenadas | Sí | |
| Código | Sí | |
| Lineas horizontales | Sí | |
| Links | Sí | |
| Imagenes | Sí | |
| Tablas | Sí | |
| Bloques de código cercados | Sí | Es posible resaltar la sintaxis del contenido del bloque. |
| Notas al pie | No | |
| ID de título | No | |
| Listas de definiciones | No | |
| Tachado | No | |
| Listas de tareas | No | |
| Emoji (copiar y pegar) | Sí | No es compatible de forma predeterminada, pero puede habilitar una extensión para usar este elemento Markdown. |
| Emoji (códigos de acceso) | Sí | MkDocs no admite códigos emoticons de forma predeterminada, pero puede instalar una extensión para formatear el contenido utilizando este elemento Markdown. |
| URL Link automático | Sí | |
| Desactivar link automático de URL | Sí | |
| HTML | Sí |