Getting started
This foundation is designed for documentation, product knowledge, handbooks, and other Markdown-first static sites.
Prerequisites
Section titled “Prerequisites”- Node.js 22.22.0 or newer. Node.js 24 is recommended.
- pnpm 12.14.0, or Corepack enabled so the pinned package manager can be used.
Install
Section titled “Install”corepack enablepnpm installThe first install creates pnpm-lock.yaml. Commit the lockfile so local and CI installs stay reproducible.
Start development
Section titled “Start development”pnpm devAstro will print the local URL, normally http://localhost:4321.
Add a page
Section titled “Add a page”Create src/content/docs/my-page.md:
---title: My pagedescription: A short description for search engines and previews.---
# My page
Write documentation here.Starlight automatically turns the file into a route and includes it in the generated navigation.
Validate before pushing
Section titled “Validate before pushing”pnpm checkThe check command verifies formatting, runs Astro diagnostics, and performs a production build.
Next steps
Section titled “Next steps”- Read Writing content.
- Review Deployment.
- See the Project structure.