- Instal.lar Python i pip
- Obrir PowerShell com administrador
pip install mkdocs-material-
mkdocs serve: Arranca un servidor web intern amb auto-recàrrega. -
mkdocs build: Compila la documentació en html. -
mkdocs gh-deploy: Publica la documentació a branch gh-pages.
- Per modificar qualsevol pàgina, cal editar el contingut dels fitxers
.mdde la carpetadocs. - Si es vol afegir una nova secció o pàgina, cal generar el fitxer
.mdcorresponent. - Si es vol editar o modificar la barra de navegació, cal actualitzar la secció
navdel fitxermkdocs.yml. - Per afegir una nova secció dins una pàgina (i que aquesta aparegui a la Taula de continguts), s'ha de referenciar de la següent manera:
#### NomSecció. - Per afegir un enllaç a una secció:
[Titol secció](document.md).
- Compilar la documentació (
mkdocs buildopython -m mkdocs build) - Copiar el contingut de la carpeta
siteal servidor corresponent.
