Starlight
by Astro
Astro's documentation-site template: navigation, search, i18n, dark mode out of the box.
Page and site templates Code libraryOpen sourceminimal
1. Price: starlight.astro.build
Fully free.
starlight.astro.buildNo quote yet: price is read from the official pages.
2. Commercial use: raw.githubusercontent.com
“Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software”
MIT allows use in paid products and for commercial docs.
raw.githubusercontent.com3. Credit the author: raw.githubusercontent.com
“The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.”
No credit on screen. Keep the license notice inside the code you ship.
raw.githubusercontent.com4. Agent access: github.com/withastro/starlight
An agent can install it by itself with npm install @astrojs/starlight. No key or account is needed.
github.com/withastro/starlightLicense checked Nov 5, 2026 against 1 official page. Tap a verdict to see its source. How we checked Report an error
Starlight: a ready documentation website from Markdown files
Starlight is a free, ready-made design and engine for documentation websites, made by the team behind the Astro website builder. You write pages as simple Markdown text files, and Starlight turns them into a site with a side menu, search, dark mode and language switching. It needs Node.js to build the site; the finished site is plain web pages you can host anywhere.
Where you can use it
Documentation for your product
Start a separate help or docs website for an app, a library or a service. You write text files, and the menu, search and page layout are already done.
A docs section on an existing site
If your website is already built with Astro, add a documentation part to it instead of running a second site on another address.
Help pages in several languages
Publish the same help pages in English, Chinese, Arabic or other languages, with a language menu. Pages not yet translated show the main language instead, and right-to-left scripts are supported.
Search with no extra service
Visitors can search all your pages from the header. The search is built into the site itself, so there is no search company to sign up with.
A front page for the docs
Give the docs a wide welcome page without the side menu, with a big heading and buttons, like the Starlight home page itself.
An internal team handbook Idea
Keep company rules, how-tos and onboarding notes as text files next to your code, and publish them as a searchable site for the team.
As reported by Astro: On a first visit a reader downloads less than 50 KB of compressed data.
Starlight popularity
Downloads from api.npmjs.org, stars from GitHub, checked Nov 17, 2026. How the Gid Score is calculated
How to start
Tell your AI assistant
“Create a documentation site with the Astro Starlight template, pin @astrojs/starlight to 0.42.10, put the pages in src/content/docs/, set the site URL so a sitemap is generated, and check that the header search works after npm run build.”
Or install it yourself. Create a new project from the Starlight template. You need Node.js 22.23.4 or newer for the current Astro.
npm create astro@latest -- --template starlight
Show codeStep 1 or Step 2
Start the local preview, then add pages as Markdown files in src/content/docs/.
npm run dev
For an Astro site you already have, add Starlight to it instead of starting a new project.
npx astro add starlight
Mistakes to avoid
Starlight reads pages through Astro content collections; the create-astro template sets this up, a manual setup does not.
The search index is made at build time.
Starlight only generates the sitemap when it knows the site URL.
It is beta software with frequent releases, and it requires a matching Astro version.
The Starlight docs name this flag for the Cloudflare adapter.
License
MIT license. Free to use for personal and paid projects, and you may change and share the code. When you share copies of Starlight's code, keep its copyright and license notice; the site you publish needs no visible credit.
“Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software” raw.githubusercontent.com
“The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.” raw.githubusercontent.com
“Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software” raw.githubusercontent.com
“Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software” raw.githubusercontent.com
AllowedWith conditionsNot allowedNot stated or not checked yet
Is Starlight free for commercial use? The full answer Not legal advice. Check the license page before you ship.
For your agent
License rules tell your agent what it may do with Starlight. Paste them into your prompt or AGENTS.md.
- Starlight (Page and site templates). Astro's documentation-site template: navigation, search, i18n, dark mode out of the box. Price: free; commercial use OK; no credit needed. Style: minimal.
Connect: npm @astrojs/starlight.
Get files: npm create astro@latest -- --template starlight; no account (mdx, astro).
Not allowed: Needs Node.js
Rule: Keep the MIT copyright notice in the code if you redistribute it.
Rule: No visible credit on the site is required by the licence.
License: https://raw.githubusercontent.com/withastro/starlight/main/LICENSE (checked 2026-11-05; details: https://agentgid.com/assets/starlight/)
Agent installs a package or loads it from a CDN.
npm install @astrojs/starlightFormats: mdx, astro
Docs built with Starlight (MIT)Alternatives
Starlight This page
Pick Docusaurus when your team works in React and wants a docs site, a blog and a landing page in one ready template.
Pick VitePress when your project already uses Vue and Vite and you want its default docs theme and home page layout.
Pick Fumadocs when the docs should live inside a Next.js or React Router app, including pages made from an OpenAPI file.
Official Bootstrap 5 example snippets and layouts: heroes, features, pricing, headers, footers, dashboards; one zip download.
Vue/Nuxt UI library (125+ components, Reka UI + Tailwind) with page-level components and MIT starter templates: landing, SaaS, docs, dashboard.
Questions
Do I need to know how to code?
You write pages as Markdown text files in src/content/docs/; the menu, search and dark mode come ready. Setting it up and building it needs Node.js, which an AI assistant can run for you.
Does search need a paid service?
No. Search is built in with Pagefind and needs no setup. Algolia DocSearch is an optional replacement through an official plugin.
Can I add it to the Astro site I already have?
Yes. Run npx astro add starlight, add the docs collection, and put the docs in a subfolder if they should live under a path such as /guides/.
Can I change how it looks?
Yes. Add your logo, use CSS and settings, and for bigger changes replace Starlight's own parts with your components.
Can I use it for a paid product's docs?
Yes. It is MIT licensed, so paid and commercial use is allowed.