Stand up a docs site
How to stand up a docs site
Section titled “How to stand up a docs site”Build a plugin’s Astro Starlight documentation site with askit-build-docs (site mode).
Scaffold
Section titled “Scaffold”Invoke askit-build-docs (site mode). It copies the pinned stack (Astro 6 + Starlight ~0.39 + astro-mermaid ~2.0) per docs-site-recipe: package.json deps, astro.config.mjs (mermaid before starlight; site + base for GitHub Pages; a generate() call at config load; the stock docsLoader() over src/content/docs/; the Starlight 0.39 items-wrapped sidebar with one autogenerate section per quadrant), src/content.config.ts, src/styles/custom.css, and the generated Pattern S setup: scripts/gen-docs-site.mjs (emits the public docs/** tree, link-rewritten, into the gitignored quadrant dirs) plus scripts/check-generated-untracked.mjs.
Verify before publishing
Section titled “Verify before publishing”Run npm run build and confirm it is green. Check that site + base match the GitHub Pages URL (a base mismatch yields “Site not found”, not a broken link). Then wire .github/workflows/deploy-pages.yml and deploy.
Author the pages
Section titled “Author the pages”Use the Diataxis doc modes (readme, quickstart, tutorial, how-to, reference, glossary, faq, troubleshooting, architecture) to fill the content; the sidebar autogenerates within each section.