History

Atul R 7680c0e6ed Docs update script (#312 ) * fix build issues * Fix docs script		2019-12-29 10:45:40 +05:30
..
blog	Adds new doc site (#124 )	2019-09-29 20:14:35 +02:00
docs	Docs update script (#312 )	2019-12-29 10:45:40 +05:30
src	Adds automatic docs for now (#308 )	2019-12-29 00:42:06 +05:30
static	Adds new doc site (#124 )	2019-09-29 20:14:35 +02:00
.gitignore	Adds new doc site (#124 )	2019-09-29 20:14:35 +02:00
docusaurus.config.js	Adds automatic docs for now (#308 )	2019-12-29 00:42:06 +05:30
package.json	Adds new doc site (#124 )	2019-09-29 20:14:35 +02:00
README.md	Adds new doc site (#124 )	2019-09-29 20:14:35 +02:00
sidebars.js	Adds automatic docs for now (#308 )	2019-12-29 00:42:06 +05:30
yarn.lock	update yarn.lock for website	2019-12-08 21:30:33 +01: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=1 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.