Website

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

Installation

pnpm install

Local Development

Option 1: With Node/pnpm installed

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.

Option 2: With Docker (no Node installation required)

If you don't have Node.js installed locally, you can use Docker.

First, build the Docker image:

docker build -t gc-docs .

Then run the development server:

docker run -p 3000:3000 \
  -v $(pwd)/docs:/app/docs \
  -v $(pwd)/src:/app/src \
  -v $(pwd)/static:/app/static \
  -v $(pwd)/docusaurus.config.ts:/app/docusaurus.config.ts \
  -v $(pwd)/sidebars.ts:/app/sidebars.ts \
  gc-docs

NOTE: If you are on windows and running in git bash you need to at the -W flag to the docker run command.

docker run -p 3000:3000 \
  -v "$(pwd -W)/docs:/app/docs" \
  -v "$(pwd -W)/src:/app/src" \
  -v "$(pwd -W)/static:/app/static" \
  -v "$(pwd -W)/docusaurus.config.ts:/app/docusaurus.config.ts" \
  -v "$(pwd -W)/sidebars.ts:/app/sidebars.ts" \
  gc-docs

Then open http://localhost:3000 in your browser. Any changes to your docs will automatically hot-reload!

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.