Getting started

Start working with Kestrel in four steps: install, build, deploy, and keep it upgraded.

Install

Requirements: Node.js 20 or newer and npm. Install the pinned dependencies:

npm ci

Use npm ci rather than a loose install so the build matches the locked dependency versions.

Build

Build the static output:

npm run build

The build writes every page to dist/, including the marketing pages, the nine documentation articles, the changelog, and the 404 page. Run the checks before shipping:

npm run check
npm run test:links
npm run test:copy
npm run test:static

Deploy

Deployment is a static file copy: publish the contents of dist/ to any static host. No server code runs, and no database is required. Configure the host so unknown paths serve the 404 page; the Troubleshooting docs explain the route behavior.

The canonical site address lives in the brand file at src/content/brands/default.js; update it to the deployed address before publishing, so canonical links point at the live site.

Upgrading

To upgrade, take a fresh copy of the package, then carry over only your own changes: the brand file, the plan object, your docs edits, and your page copy. Re-run the full check set above; a green set means the upgraded build is safe to publish.

Continue with the Library docs.