This documentation site is built using Docusaurus 2, a static site generator.

Feel free to contribute towards making our documentation better.

We merge changes from Develop on a weekly basis. The changes to Master are pushed to production ever so often.

$ yarn

$ yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.