Documentation

Yokai automated documentation, based on Material for MkDocs.

• Public version
• Contributing

Public version

Yokai public documentation is available at https://ankorstore.github.io/yokai/.

Contributing

Before triggering the docs workflow, you can test your documentation changes by running (from the repository root):

docker build -t squidfunk/mkdocs-material docs && docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

This will make the documentation available locally on http://localhost:8000.