Welcome to MkDocs

MkDocs es una herramienta que convierte archivos de texto en formato Markdown en una página web completa de documentación de forma automática. Tú escribes el contenido en archivos .md, organizas la estructura en un archivo de configuración (mkdocs.yml), y MkDocs se encarga de generar una web con navegación, menú lateral y diseño listo para usar. Es muy popular para documentación de proyectos porque es simple, rápido y no requiere conocimientos de HTML o JavaScript; además, puede previsualizarse en local y luego exportarse como una web estática que se puede subir fácilmente a servicios como GitHub Pages o Neocities.

For full documentation visit mkdocs.org.

VOLVER AL JARDÍN mijardindigital.

Commands

• mkdocs new [dir-name] - Create a new project.
• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.
• mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.