Se usa mkdocs con el tema mkdocs-material.
Desinstalar versiones anteriores de mkdocs:
sudo pip uninstall mkdocs
E instalar con el comando:
pip install mkdocs-material
mkdocs serve
: Arranca un servidor web con auto-recarga.mkdocs build
: Compila la documentación en html.mkdocs gh-deploy
: Publica la documentación en gh-pages.
mkdocs.yml # El fichero de configuración.
docs/
index.md # La portada.
... # Otras páginas en markdown, imágenes, etc.
- Chuleta rápida sobre links, imágenes y tablas en markdown: http://www.mkdocs.org/user-guide/writing-your-docs/#linking-documents
- Especificación Markdown completa.
- Visual Studio Code ofrece una vista de Preview que va mostrando el resultado del markdown en tiempo real sin tener que salir del editor.