History

Alex 0f9c2f0a38 doc: Add content for usage section (#922 )		2022-11-03 21:42:24 -05:00
..
blog	Change documentation folder to docs	2022-10-27 21:44:37 -05:00
docs	doc: Add content for usage section (#922 )	2022-11-03 21:42:24 -05:00
src	doc/update overview section (#904 )	2022-10-31 06:37:36 -05:00
static	docs: add installation section (#912 )	2022-11-01 20:01:03 -05:00
.gitignore	Change documentation folder to docs	2022-10-27 21:44:37 -05:00
babel.config.js	Change documentation folder to docs	2022-10-27 21:44:37 -05:00
docusaurus.config.js	doc: Add content for usage section (#922 )	2022-11-03 21:42:24 -05:00
package-lock.json	Change documentation folder to docs	2022-10-27 21:44:37 -05:00
package.json	Change documentation folder to docs	2022-10-27 21:44:37 -05:00
README.md	Change documentation folder to docs	2022-10-27 21:44:37 -05:00
sidebars.js	Change documentation folder to docs	2022-10-27 21:44:37 -05:00
tsconfig.json	Change documentation folder to docs	2022-10-27 21:44:37 -05: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 opens 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.

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> 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.