Contributing

If you would like to contribute to the website, please create a new branch. Once you have created a new branch, you can modify or create new docs within the /docs/ directory.

Once you have finished, go to the root of the repo and open a pull request. We will review it, provide any feedback/changes if required then merge your branch into main.

--

Website

This website is built using Docusaurus, 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.