Skip to main content

🚀 Quick Start - API Documentation (TypeDoc)

This project generates API docs with TypeDoc from the root package scripts.

⚡ Super Quick Start​

# From repository root
npm install
npm run docs:build
npm run docs:serve

Then open: http://localhost:8080

🎯 What Each Command Does​

CommandPurpose
npm installInstalls dependencies, including TypeDoc
npm run docs:buildGenerates API docs into docs/api/
npm run docs:serveServes docs/api/ with Python HTTP server on port 8080
npm run docs:cleanRemoves generated API docs

🆘 Troubleshooting​

typedoc: command not found​

Run dependency install first:

npm install

Port 8080 already in use​

Use another port:

cd docs/api
python3 -m http.server 8081

TypeDoc warnings during build​

  • @category / @description warnings are resolved by the current TypeDoc config.
  • If warnings reappear, verify typedoc.json is up to date and rebuild.

📎 Related Docs​