README-docusaurus.md

Website

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

Installation

$ pnpm

Local Development

$ pnpm 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.

However, the searchbar may not function with yarn start. Instead, run yarn build and launch a server:

$ npx http-server ./build

Build

$ pnpm 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 pnpm deploy

Not using SSH:

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