Go to file

Derrick Hammer 338a100c50 refactor: docs rewrite		2023-09-30 00:36:22 -04:00
docs	refactor: docs rewrite	2023-09-30 00:36:22 -04:00
static	refactor: docs rewrite	2023-09-30 00:36:22 -04:00
.releaserc.json	refactor: docs rewrite	2023-09-30 00:36:22 -04:00
README.md	feat: initial version	2023-09-06 07:52:18 -04:00
babel.config.js	feat: initial version	2023-09-06 07:52:18 -04:00
docusaurus.config.js	refactor: docs rewrite	2023-09-30 00:36:22 -04:00
package-lock.json	refactor: docs rewrite	2023-09-30 00:36:22 -04:00
package.json	refactor: docs rewrite	2023-09-30 00:36:22 -04:00
sidebars.js	refactor: docs rewrite	2023-09-30 00:36:22 -04:00
tsconfig.json	feat: initial version	2023-09-06 07:52:18 -04: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.