Quick start
QuickstartCreate your repo from the template, install, and see the docs in the browser.
You need Node 26 and pnpm 12 (see .node-version and packageManager in package.json).
1. Create your repo
Section titled “1. Create your repo”Use Use this template on GitHub, or:
gh repo create my-docs --template milzamsz/astro-starlight-starter --clonecd my-docs2. Install and run
Section titled “2. Install and run”pnpm installpnpm devOpen http://localhost:4321. The root redirects to /docs/.
3. Make it yours
Section titled “3. Make it yours”- Set the name and URL in
src/config/site.config.ts. - Edit groups, tabs and links in
src/config/docs.config.ts. - Replace the articles under
src/content/docs/docs/. - Pick your brand color: Customize the look.
4. Check and build
Section titled “4. Check and build”pnpm lintpnpm testpnpm buildpnpm build also builds the search index. Preview the result with pnpm preview.
Next steps
Section titled “Next steps”Was this helpful?