Crabby Documentation Website

The official documentation website for Crabby made in Docusaurus.

Installation

bun i

Local Development

bun run 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

bun run build

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

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true bun 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.