Documentation Guide

This project's documentation is using docusaurus to generate docs from markdown files and loaded in a react app.

To extend the doc simply create a markdown file and reference the ID in the side bar. Please see the related documentation at the docusaurus 2 project website.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and open 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.