History

checktheroads ee87c34ff1 fix docs sitemap generation [skip ci]		2020-07-14 01:10:47 -07:00
..
docs	update main button text, fix syntax error [skip ci]	2020-07-14 00:33:43 -07:00
screenshots	docs	2020-02-08 00:58:32 -07:00
src	update main button text, fix syntax error [skip ci]	2020-07-14 00:33:43 -07:00
static	Update docs with new opengraph info	2020-07-04 15:18:53 -07:00
.gitignore	docs	2020-02-08 00:58:32 -07:00
docusaurus.config.js	fix docs sitemap generation [skip ci]	2020-07-14 01:10:47 -07:00
generateSitemap.js	SEO improvements	2020-06-06 01:41:10 -07:00
package.json	SEO improvements	2020-06-06 01:41:10 -07:00
README.md	docs	2020-02-08 00:58:32 -07:00
sidebars.js	docs restructure	2020-06-21 14:12:08 -07:00
yarn.lock	SEO improvements	2020-06-06 01:41:10 -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.