History

checktheroads e413152203 docs updates		2020-02-13 01:58:43 -07:00
..
docs	docs updates	2020-02-13 01:58:43 -07:00
screenshots	docs	2020-02-08 00:58:32 -07:00
src	docs updates	2020-02-13 01:58:43 -07:00
static/img	fix docs images	2020-02-08 08:36:32 -07:00
.gitignore	docs	2020-02-08 00:58:32 -07:00
docusaurus.config.js	docs updates	2020-02-13 01:58:43 -07:00
package.json	docs	2020-02-08 00:58:32 -07:00
README.md	docs	2020-02-08 00:58:32 -07:00
sidebars.js	docs updates	2020-02-11 00:36:43 -07:00
yarn.lock	docs	2020-02-08 00:58:32 -07: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.