README.md

The Calva Documentation Distillery

For Calva Documentation - calva.io.

The documentation is built using MkDocs + MkDocs Material and are hosted by GitHub Pages.

How to Update the Docs

Please feel invited to improve the Calva Docs! Like so:

0. Install MkDocs + Materials

   pip install -r requirements.txt

   (Or your preferred method from https://squidfunk.github.io/mkdocs-material/getting-started/)

   If you get an error with the pip install method above, you may have an older version of python. If you install python 3.7 and run the following command, it should work:

   python3.7 -m pip install -r requirements.txt

1. Run the MkDocs server:

   mkdocs serve

2. Visit http://localhost:8000

3. Edit docs. It's all Markdown. When you save, the changes will be reloaded in the browser.

Note: The MkDocs Markdown is a bit pickier than GitHub's, so make sure to use four indents, put an empty line before bulleted lists, and so on. The VS Code extension markdownlint helps with following the appropriate style. And make sure to check the results at your local site.

Currently there is no CI, so once it looks fine at your local site, file the PR.

Updating calva.io

Only users with push access to this repo can do this:

mkdocs gh-deploy --clean