Website

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

Installation

npm install

Local Development

npm 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

npm build

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

Deployment

Pushes to master or pull requests into master automatically trigger a Github action that builds the documentation and deploys it to gh-pages branch.

It shouldn't be necessary, but if you want to manually deploy code to gh-pages branch:

GIT_USER=<Your GitHub username> DEPLOYMENT_BRANCH=gh-pages USE_SSH=true npm deploy