History

Atul R 2ceed980b4 adds test docs (#695 ) * adds test docs * update docs * update api docs * change to master		2020-09-19 20:12:08 +02:00
..
blog	Adds new doc site (#124 )	2019-09-29 20:14:35 +02:00
docs	adds test docs (#695 )	2020-09-19 20:12:08 +02:00
src	Fix typos (#577 )	2020-05-24 13:04:42 +02:00
static	Adds new doc site (#124 )	2019-09-29 20:14:35 +02:00
.gitignore	Fix docs website	2020-03-15 12:35:48 +01:00
docusaurus.config.js	adds test docs (#695 )	2020-09-19 20:12:08 +02:00
package.json	adds test docs (#695 )	2020-09-19 20:12:08 +02:00
README.md	Fix docs website	2020-03-15 12:35:48 +01:00
sidebars.js	bump version and update docs & deps	2020-07-04 20:03:59 +02:00
yarn.lock	adds test docs (#695 )	2020-09-19 20:12:08 +02:00

Website

This website is built using Docusaurus 2, a modern static website generator.

$ 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.