notes on adding documentation
This Repository is based on MkDocs and uses the multirepo plugin The mkdocs.yml at the top level of the repository
To add a new section, you add an import to the nav section based on: https://github.com/jdoiro3/mkdocs-multirepo-plugin#setup
In your repo, you add a mkdocs.yml
Markup cheat sheet
For good examples and editable pages see Geocodes
Note
We are using mkdocs, so admonitions and pymarkdown extensions but the pymarkdown stuff needs to be ebabled: https://pypi.org/project/mkdocs-callouts/
https://squidfunk.github.io/mkdocs-material/reference/admonitions/#configuration
MKDOCS References
Mkdocs on github how tos:
- example
- https://blog.elmah.io/deploying-a-mkdocs-documentation-site-with-github-actions/
- https://blog.elmah.io/hosting-a-mkdocs-driven-documentation-site-on-github-pages/