The npm scripts

Eight npm scripts in docs/ run, measure, generate, check and build the site.

dev. Write the page and look at it in the browser.

1 / 6

From a new page to the export

What each script does

Run each script in docs/.

Script	What it does
`npm run dev`	Next.js dev server with hot reload
`npm run build`	Static export to `out/`, then the link check
`npm start`	Serves `out/` locally
`npm run typecheck`	`next typegen && tsc --noEmit`
`npm run generate`	Regenerates the reference pages from the Rust code (needs `cargo`)
`npm run generate:check`	Fails when a generated file is stale
`npm run check-links`	Checks `out/` for broken internal links and anchors
`npm run check-content`	Measures the pages against the rules of `AUTHORING.md`: simple English, words per page, figures

Run the site on your machine

Three commands start the dev server of the docs. Each change of a page shows in the browser.

Write a page

Each page is short and starts with a picture. The file docs/AUTHORING.md is the contract.