Start with Docusaurus

This site is built using Docusaurus, a modern static site generator.

Docusaurus documentation

Prerequisites

You need to have pnpm installed. If you don't have it yet, you can install it globally:

bash
npm install -g pnpm

Or visit pnpm.io for other installation methods.

Installation

bash
pnpm install

Local Development

bash
pnpm start

This command starts a local development server and opens a browser window. Most changes are reflected live without needing to restart the server.

Build

bash
pnpm build

This command generates static content in the build directory and can be served using any static content hosting service.

Generate OpenAPI Documentation

To generate API documentation from OpenAPI specifications:

bash
pnpm gen-api-docs

Deployment

Using SSH:

bash
USE_SSH=true pnpm deploy

Without SSH:

bash
GIT_USER=<Your GitHub username> pnpm deploy

If you are using GitHub Pages for hosting, this command is a convenient way to build the site and push it to the gh-pages branch.