Sensimity API documentation project

The documentation is written in Markdown (yes, GitHub flavoured) and we use mkdocs to build it.

Building the docs

Make sure you have mkdocs installed on your system.

You can then build the docs via the following command:

$ mkdocs build --clean

The docs are best viewed via your browser, so start a webserver:

$ php -S 127.0.0.1:8080 -t site/

And view them in your browser:

open http://127.0.0.1:8080/

If you are satisfied with the state of the docs execute:

git checkout master
git pull upstream master
mkdocs gh-deploy -c -r upstream

This will update the github pages of https://sensimity.github.io/docs

Editors

Some suggestions for editors:

• MacDown (for Mac)
• Mou (for Mac)
• Online editor
• PhpStorm with MD plugin