Go to file
Derrick Hammer b2912aee26
fix: grammar
2023-11-01 04:34:40 -04:00
.github/workflows ci: setup 2023-09-30 00:56:15 -04:00
docs fix: grammar 2023-11-01 04:34:40 -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
CHANGELOG.md chore(release): 0.1.4-develop.1 [skip ci] 2023-11-01 07:29:20 +00: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 fix: update footer menu 2023-11-01 03:27:27 -04:00
package-lock.json feat: add matomo 2023-09-30 01:36:19 -04:00
package.json chore(release): 0.1.4-develop.1 [skip ci] 2023-11-01 07:29:20 +00: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

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ 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.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

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.