About
Small, static, verifiable.
Field Notes is a deliberately small knowledge base that exercises the whole static-site toolchain: content collections, nested routes, local assets and a fully client-side search.
What it is
9 articles live in an Astro content collection (src/content/articles/) with a typed schema insrc/content.config.ts. The production build pre-renders every route to plain HTML under dist/:
/— home with hero, categories and recent notes/library/— search & browse all notes (embedded client search)/library/articles/[slug]/— each article detail page/library/categories/and/library/categories/[name]/— nested category browsing/about/— this page/404— styled not-found page
How search works
The article index is embedded in the library page at build time. The matcher lives insrc/lib/search.mjs — a pure, dependency-free module that scores title, tag, category, description and body text. It runs in the browser after load and is covered by the same unit tests. A dedicated empty state is shown when nothing matches.
Install, build and run
| Command | Purpose |
|---|---|
npm ci | Reproducible install from the lockfile |
npm run dev | Dev server on 127.0.0.1:4321 |
npm run build | Write the static site to dist/ |
npm run preview | Serve built dist/ on 127.0.0.1:4321 |
npm run check | astro check type checks |
npm test | Unit tests + end-to-end smoke suite |
Runtime and environment
- Runtime: Node.js 22.12+ (pinned via
engines), npm with a committedpackage-lock.json - Bind:
127.0.0.1(host can be overridden with--host) - Port:
4321for dev/preview (override with--portorPORT) - Environment: no secrets. Copy
.env.exampleif you want to set optional values.
Health and persistence
This is a static site — there is no database, backend or worker process, so traditional liveness/readiness probes and restart persistence checks do not apply. /healthz.txtis an honest static availability marker only, and deployment status is tracked inVERIFICATION.md, not inferred from a static file.
Build marker
Every page footer shows the exact revision this build came from (see below), generated byscripts/build-info.mjs at build time and recreated on every build.
static · v1.0.0 · commit a099a08d · astro 7.3.3 · 2026-11-19
commit full: a099a08d5d3ba05a5219ba728fd6f824c2c9ff7e