Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 988 Bytes

File metadata and controls

39 lines (28 loc) · 988 Bytes

Docusaurus Documentation Setup

This project uses Docusaurus to generate interactive documentation that can be browsed on GitHub Pages.

Prerequisites

  • Node.js 20.x (use nvm use to switch to the correct version)
  • npm

Local Development

  1. Switch to the correct Node version (if using nvm):

    nvm use
  2. Install dependencies (if not already installed):

    npm install
  3. Start the development server:

    npm run docs:dev

    This command starts a local development server at http://localhost:3000 and opens up a browser window. Most changes are reflected live without having to restart the server.

  4. Build the documentation:

    npm run docs:build

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

  5. Serve the built documentation locally:

    npm run docs:serve