Documentation¶

This documentation site has been put together by the community and it is a constant work in progress.

If you find a typo or want to help with documentation in general, you are welcome to open and issue and work on it.

Run the site locally¶

To build the documentation site locally you can do the following:

python3 -m venv .venv
source .venv/bin/activate
pip install zensical
zensical serve

For more details see the Zensical documentation

Check for spelling errors¶

You can check the site for spelling errors before committing with this commands:

npm i markdown-spellcheck -g
mdspell --en-us -n -a --report 'docs/**/*.md'