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.

Structure

This website has a landing page with certain cards that redirect to documentation sections (not subsections). It has a navbar and a search bar. The navbar in standard docusarus only supports one logo.

Anytime the folder structure in the docs/ folder changes and folders are added or removed - the landing page card references might be broken so they must be updated accordingly. As well as docusaurus.config.js.

Each .md file added in the docs/ folder has a small header that indicates its ordering relative to other docs and how it displays in the section dropdown - in the subsection rows. You can tweak this order however you need in each of the files but make sure the other files are updated in case the order number conflicts. You also have a catgegory.json for all of the folders you add in the docs/ main folder that indicate their position on the sidebar.