Skip to content
Agents tracked: 502 Releases (7d): 613 Agent status: 4 with issuesSince last limit reset: Claude 7d · Codex 5d For AI agents: Markdown Updated Nov 18, 2026

Starlight

by Astro

Astro's documentation-site template: navigation, search, i18n, dark mode out of the box.

Page and site templates Code libraryOpen sourceminimal

GitHub repoWebsite

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.com

License 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

49 / 100
Gid Score, same scale as developer tools
9,605
GitHub stars
2.4M
npm downloads, last 7 days
+46.2% in 4 weeks
4
AI-agent projects using it, from our repo scan of 4,817
Starlight: downloads per weeknpm, @astrojs/starlight 2,350,184
Starlight: GitHub starswithastro/starlight 9,605

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

Mistakes to avoid

Adding @astrojs/starlight to astro.config.mjs only and expecting pages in src/content/docs/ to show up
Also create src/content.config.ts with a docs collection that uses docsLoader() and docsSchema()

Starlight reads pages through Astro content collections; the create-astro template sets this up, a manual setup does not.

Testing the header search in npm run dev and concluding it is broken
Run npm run build (and preview the build) before checking search

The search index is made at build time.

Expecting a sitemap without setting the site address
Set site: 'https://your-domain' in astro.config.mjs

Starlight only generates the sitemap when it knows the site URL.

Leaving the Starlight version floating (^0.x) and updating Astro on its own
Pin @astrojs/starlight exactly and update Starlight and Astro together with npx @astrojs/upgrade

It is beta software with frequent releases, and it requires a matching Astro version.

Deploying a server-rendered Starlight site to Cloudflare without extra settings
Add the nodejs_compat compatibility flag to the Wrangler configuration

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.

Commercial use
Yes

“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

Credit
Not needed

“The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.” raw.githubusercontent.com

Inside your app or game
Can ship inside your app

“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

Pass the files on to your users
Allowed

“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

AI training
Not stated
Bots and bulk downloads
Not stated

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.

License rules
- 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/)
Can an agent use it by itself?
Yes.

Agent installs a package or loads it from a CDN.

Install
npm install @astrojs/starlight
How an agent gets files
npm create astro@latest -- --template starlight; no account.

Formats: mdx, astro

API, key or account
Not needed. Everything runs on your side.
MCP server
None found
Credit line, if you want one
Docs built with Starlight (MIT)
This card for machines

Alternatives

Starlight This page

Free Commercial OK npm

Docusaurus

Pick Docusaurus when your team works in React and wants a docs site, a blog and a landing page in one ready template.

Free Commercial OK npm

VitePress

Pick VitePress when your project already uses Vue and Vite and you want its default docs theme and home page layout.

Free Commercial OK npm

Fumadocs

Pick Fumadocs when the docs should live inside a Next.js or React Router app, including pages made from an OpenAPI file.

Free Commercial OK npm

Bootstrap Examples

Official Bootstrap 5 example snippets and layouts: heroes, features, pricing, headers, footers, dashboards; one zip download.

Free Commercial OK npm

Nuxt UI

Vue/Nuxt UI library (125+ components, Reka UI + Tailwind) with page-level components and MIT starter templates: landing, SaaS, docs, dashboard.

Free Commercial OK npm

All page and site templates

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.