Resumen de MkDocs¶

MkDocs es un generador rápido de páginas web estáticas orientado a la creación de documentación de proyectos.

Los archivos fuente de documentación se escriben en Markdown y se configuran con un solo archivo de configuración YAML, que es un formato de serialización de datos legible por humanos inspirado en lenguajes como XML, C, Python o Perl.

Con MkDocs podemos crear sitios HTML estáticos que se pueden alojar en páginas GitHub o en cualquier otro lugar que elijamos. En nuestro caso lo haremos en GitHub.

Existen infinidad de temas o plantillas disponibles para MkDocs que podemos elegir de entre los integrados, seleccionar alguno de los que se citan en la wiki MkDocs Themes o crear el nuestro propio.

Una de las grandes ventajas que nos ofrece MkDocs es la de obtener una vista previa de nuestro sitio mientras trabajamos. Esto se consigue mediante el servidor de desarrollo incorporado que incluso recargará y actualizará automáticamente nuestro navegador cada vez que guardemos los cambios.

MkDocs es fácil de personalizar por lo que permite obtener la documentación de nuestro proyecto tal como lo deseamos personalizando el tema y/o instalando algunos complementos.

En el enlace correspondiente de la webgrafía tenemos toda la información necesaria para realizar pruebas con MkDocs.