How to Add Documentation

Built with mkdocs and material, and hosted on GitHub pages: lind-project.github.io/lind-wasm.

You can improve the docs by editing the files below. See mkdocs and material user guides for details. And don't forget to try out your changes locally!

Important files

• .github/workflows/docs.yml: Auto-deploys on push to main (e.g. on PR merge)
• mkdocs.yml: Site config (e.g. navigation and plugins)
• docs/: Site sources

Build site locally

# Install requirements (hint: use a virtual environment)
pip install mkdocs-material

# Run dev server and check output!
mkdocs serve

Note

Please also document your implementation source code following the used programming language's standards.