javiabellan / biblia

Toda mi documentación personal

How to write mkdocs documentation

See this tutorial

Deploy on Read the Docs: https://biblia.readthedocs.io

Necessary files

• File .readthedocs.yaml according to this
• File requirements according to this

The documentation is deployed automatically on every commit.

Deploy on Github Pages: https://javiabellan.github.io/biblia

Necessary files

Add this extra line in mkdocs.yml file

remote_branch: gh-deploy

Test deploy on localhost

• mkdocs new [dir-name] - Create a new project.
• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.

Manual deploy on Github pages

• mkdocs gh-deploy --clean - Desplegar/Actualizar la documentación MkDocs en la rama gh-deploy.

Automatic deploy on Github pages with github Actions

See the Githug action file .github/workflows/deploy-gh-pages.yml

Source