Awesome
WTF Docs
This site is built using Material for MkDocs.
Development environment setup
- Install python 3
- Create a virtual-env:
python -m venv virtual-env
source virtual-env/bin/activate
pip install -r requirements.txt
mkdocs serve
To add documentation for a new module
- Create a new Markdown file in the
/docs/modules
directory - Add a new route in the
mkdocs.yml
file, under thenav:
section. - To add pictures, add the image to
./docs/overrides/assets/modules/<IMAGE>.png
Deploying
- Merge changes into
master
- Run
mkdocs gh-deploy --force
to push the changes to thegh-pages
branch on github.com - Commit the resulting changes into
master