Documentation

Commands

Root and workspace commands used to build, test, lint, and document the monorepo.

Root commands

npm install
npm run build:package:full
npm run build:package:light
npm test
npm run coverage
npm run eslint
npm run prettier:apply
npm run docs:lint
npm run docs:build
npm run check

npm run check is the broad quality gate. It cleans package builds, formats, lints, type-checks, tests, and lints Markdown.

Workspace commands

npm run --workspace @plumile/router build:package
npm run --workspace @plumile/router test:build-package
npm run --workspace @plumile/backoffice-core build:package
npm run --workspace @plumile/router-devtools-extension build

Use workspace commands for narrow verification while developing a package.

Site commands

npm run docs:site:serve
npm run docs:site:check
npm run docs:site:build
npm run docs:all

These commands are added by the Zola documentation site work.

Netlify uses npm run docs:all as the production build command and publishes website/public.

Just shortcuts

just website-check
just website-serve
just website-build-local
just website-build
just docs-build-local
just docs-build
just docs-clean

The Just recipes mirror the documentation build flow used by other Plumile repositories: generate API docs, sync them into the Zola static tree, build the site, and optionally clean generated site artefacts.