README.md

Website

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

How to deploy

This deployes through github actions!

how to use locally

• npm install
• npm start

Original README.md generated by Docusaurus (needs to be integrated into new README.md part above this)

npm start Starts the development server.

npm run build Bundles your website into static files for production.

npm run serve Serves the built website locally.

npm deploy Publishes the website to GitHub pages.

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.