starlight-handbook-kit

Scaffold and extend Astro + Starlight documentation handbooks with nine CI integrity gates.

1|Updated May 28, 2026
One-click install
npx skills add https://github.com/dhanesh/agent-skills --skill starlight-handbook-kit-dhanesh
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: starlight-handbook-kit
Source: https://github.com/dhanesh/agent-skills/tree/main/starlight-handbook-kit
Command: npx skills add https://github.com/dhanesh/agent-skills --skill starlight-handbook-kit-dhanesh

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires astro, @astrojs/starlight, @astrojs/react, @astrojs/markdown-remark, react, react-dom, mermaid, and includes assets (resource) components.

What problem does it solve? Standing up a documentation site that stays consistent as it grows is hard: pages drift from the intended structure, diagrams silently render as code, links break under a deploy base path, and stale recommendations ship unnoticed. This Skill scaffolds a decision-oriented Astro + Starlight handbook where every topic follows a fixed nine-section skeleton and nine dependency-free CI gates fail the build the moment content drifts from the contract, making agent-authored documentation safe to ship. ## Core Features & Use Cases - Mode A — Scaffold a new site: Copy a complete, gate-passing Astro + Starlight site from the bundled template, substitute five placeholders (package name, site title, description, deploy base, GitHub Pages host), then install and verify. - Mode B — Author content: Add a single topic page from the canonical template or a whole cluster (directory with overview plus topics), wiring each into the sidebar and home page, then re-verify. - Nine CI gates: Template integrity, pages-built, frontmatter dates, section skeleton, accessibility/no-JS, artifact hygiene, internal links, mermaid usage, and content freshness — all dependency-free Node scripts. - Use Case: Ask the agent to stand up a new engineering handbook for your team; it copies the scaffold, fills in your site title and GitHub Pages host, and delivers a site that passes all nine gates out of the box with one example cluster. ## Quick Start Ask the agent to scaffold a new Astro Starlight handbook site named my-handbook with a title, description, and GitHub Pages host, then run npm install and npm run verify.

Frequently Asked Questions about starlight-handbook-kit

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I scaffold a new Astro Starlight documentation site?▼

Copy the bundled scaffold template into your target repo, substitute the five placeholders (package name, site title, description, deploy base, GitHub Pages host), then run npm install and npm run verify. A fresh scaffold passes all nine integrity gates out of the box.

How do I add a new topic page to a Starlight handbook?▼

Copy templates/topic.mdx into src/content/docs/<cluster>/<topic>.mdx, fill in the frontmatter including a last_reviewed ISO date, complete all nine sections in the fixed order, register the page in the astro.config.mjs sidebar, and run npm run verify.

Does Starlight render fenced mermaid code blocks as diagrams?▼

No. Starlight's Expressive Code renders a fenced mermaid block as syntax-highlighted code, not a diagram. Use the <Mermaid code={...} /> component instead; the verify:mermaid gate fails the build if a fenced mermaid block appears in content.

What Node.js version is required for Astro Starlight builds?▼

The skill requires Node.js 18+ with npm for Astro + Starlight builds, and the scaffold's CI workflow uses Node 20. The nine integrity gate scripts themselves are dependency-free Node scripts using only builtins.

Why does the freshness check fail on a missing last_reviewed date?▼

The freshness gate fails closed when last_reviewed is missing or malformed because an undated topic is an integrity violation. A topic merely overdue for its review window (12 months volatile, 24 months stable) produces only a non-blocking warning.

How do I deploy a Starlight handbook to GitHub Pages?▼

Set the deploy base placeholder to your repository name for a project page, or an empty string for a user/org root page, plus your GitHub Pages host. The bundled deploy.yml workflow builds, runs all verify gates, and publishes to GitHub Pages on every push to main.