Documentation that works the way docs should: write Markdown, get a site.
Halyard uses Astro content collections, so frontmatter is type-checked and a bad schema fails the build instead of shipping a broken page. Drop a .md file into src/content/docs/ and you get a routed page, a sidebar entry in the right group, and prev/next links — no config to update.
The verification gate ships inside the download. Run npm run gate and it installs, typechecks, builds, audits dependencies, serves the site, runs Lighthouse, and runs 11 browser assertions.
If you need versioned docs and i18n out of the box, use Starlight instead — it is free and does both. Halyard is smaller, has far less surface area, and is easier to modify when you want it to look like yours rather than like Starlight.
Key features
- Lighthouse 100 — performance, accessibility, best practices and SEO, all four
- Verification gate included — npm run gate reproduces every score on your machine
- 11 browser assertions — required head tags, no broken internal anchors, keyboard-visible skip link, alt text on every image, no console errors, no horizontal scroll
- Type-safe content collections — a bad frontmatter schema fails the build, not the page
- Auto-generated sidebar from your content tree, grouped and ordered
- Prev/next pager, slug-based routing — drop in a .md file, get a page
- Dark mode that persists, six example doc pages to delete or build on
- Node 22.12+, deploys anywhere static
