Skip to content

WorldJen Docs

VitePress-powered documentation site for WorldJen.

Local

bash
cd docs && npm ci && npm run dev

Open http://localhost:5173

Build

bash
npm run build

Output is in docs/dist. The deploy workflow builds the docs app and uploads docs/dist to GitHub Pages.

OpenAPI / Scalar

The REST API page uses Scalar and loads docs/public/openapi.json. cd server && npm run openapi refreshes that file together with server/openapi.json.