This project uses Docusaurus to generate interactive documentation that can be browsed on GitHub Pages.
- Node.js 20.x (use
nvm useto switch to the correct version) - npm
-
Switch to the correct Node version (if using nvm):
nvm use
-
Install dependencies (if not already installed):
npm install
-
Start the development server:
npm run docs:dev
This command starts a local development server at
http://localhost:3000and opens up a browser window. Most changes are reflected live without having to restart the server. -
Build the documentation:
npm run docs:build
This command generates static content into the
builddirectory and can be served using any static hosting service. -
Serve the built documentation locally:
npm run docs:serve