OpenCal Documentation Repository

Here you find the documentation files for OpenCal. It uses MkDocs with Material design.

Getting started locally

First, clone this repository:

git clone git@git.var-lab.com:opencal/documentation.git

You can start a server using docker to view the rendered documentation in your browser (refreshes automatically if you change files):

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

Another way is to install mkdocs (see https://squidfunk.github.io/mkdocs-material/getting-started/)

pip install mkdocs-material

and serve it with this command:

mkdocs serve