Website

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

Installation

yarn

Local Development

yarn dev

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.

How to contribute

Generally, you can contribute via Pull Requests. The following branch conventions are required:

• feat/*: for a new feature
• fix/*: for fixing a bug
• refactor/*: for improving code maintainability without changing any logic

For committing new changes Conventional Commits have to be used.

When your Pull Request is ready, it can be opened against the main branch. Once the owners have approved your Pull Request, your changes get merged.