- HOWTO
- create documentation
-
How to work with our documentation system
mkdocs new [dir-name]
- Create a new project. For adhocracy+ we save documentation files under docs
folder.
- Add a section under the
nav
element in mkdocs.yml
and link to the documentation file.
mkdocs serve
- Start the live-reloading docs server.
mkdocs build
- Build the documentation site.
mkdocs -h
- Print help message and exit.
Deploy the docs
- Open a PR with the docs changes
- Once the PR is merged, pull latest main
- run
mkdocs gh-deploy