Documentation

To update the documentation, feel free to modify / add markdown file in the /docs folder of the repository

Preview Locally

To build locally your github pages site

$ mkdocs build

To test locally your github pages site

$ mkdocs serve

Publish on github pages

Simply commit your modification on your branch, issue a PR and the workflow publication_pages_gh-pages_branch.yml will be triggered automatically.

Note: (Wrong behaviour) to manually push your modification directly to github pages you can execute the command:

$ mkdocs gh-deploy