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

$ GIT_USER=<Your GitHub username> USE_SSH=true 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.

Creating a page

---

sidebar_label: 'Hi!' //Title in the sidebar - by default uses the first line in the file if not set sidebar_position: 3 //Ordering in the sidebar id: my-doc-id //Unique ID title: My document title description: My document description slug: /my-custom-url //Custom URL - by default uses the file name

---