This directory contains the Docusaurus site that powers the Chipro documentation set. It is a standard Docusaurus v3 project with a small amount of custom styling and plugins (image zoom).
npm ci # reproducible install
# or
npm install| Command | Description |
|---|---|
npm run start |
Launches the hot-reloading dev server at http://localhost:3000. |
npm run build |
Produces the optimized static site in build/. |
npm run serve |
Serves the existing build/ directory for testing (no rebuild). |
npm run clear |
Cleans the .docusaurus cache – run if the dev server behaves oddly. |
-
Install dependencies.
-
Start the dev server:
npm run start
-
The site opens automatically; edit files in
docs/docs,docs/src, ordocs/static. Changes hot-reload without restarting the server.
If you add new sidebar entries, update sidebars.ts. For global settings (navbar, footer, plugins) edit docusaurus.config.ts.
npm run build # emits static files to build/
npm run serve # (optional) run locally to smoke-test the buildUpload the contents of build/ to any static host (S3, Netlify, Vercel, etc.).
A two-stage Dockerfile is included for consistent builds:
# build the image
docker build -t chipro-docs .
# serve on localhost:3000
docker run --rm -p 3000:3000 chipro-docs