Aprender MkDocs

Para obtener la documentación completa, visite mkdocs.org.

Comandos

  • mkdocs new [dir-name] - Crear un nuevo proyecto.
  • mkdocs serve - Inicia el servidor de documentación de recarga en vivo.
  • mkdocs build - Crea el sitio de documentación.
  • mkdocs -h - Imprime el mensaje de ayuda y salir.

Organización del proyecto

mkdocs.yml    # Archivo de configuracion.
docs/
    index.md  # La documentación del homepage.
    ...       # Otras páginas de Markdown, imágenes y otros archivos.