This guide can be accessed here.
pip install mkdocs-material mkdocstrings[python] pymdown-extensions
mkdocs serve
to host it locally with hot-reload
Please check out these links.
https://squidfunk.github.io/mkdocs-material/setup/
https://www.mkdocs.org/getting-started/#adding-pages
If you want to host this on a custom domain make sure to create a CNAME
file in the ./docs directory and put your domain in there.
Like it was done here.
We welcome any and all contributions to this guide. If you would like to contribute, you can do so via any of the below methods:
- Have any suggestions or found an issue? Leave an issue or join our Discord server.
- Would you like to contribute a page? Please create a Pull Request and we will review it as soon as we can!