This website is built using Docusaurus 3, a modern static website generator.
- Node.js
>= 20 - npm
>= 10
$ npm ci
$ npm 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.
$ npm run build
This command generates static content into the build directory and can be served using any static contents hosting service.
Build only docs site:
$ npm run build:docs
Build only homepage:
$ npm run build:home
Run setup checks (TypeScript + both build targets):
$ npm run check
Using SSH:
$ USE_SSH=true npm run deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> npm run 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.