{
 "slug": "starlight",
 "name": "Starlight",
 "author": "Astro",
 "density": "full",
 "status": "active",
 "status_note": null,
 "alternatives_page": null,
 "one_liner": "Astro's documentation-site template: navigation, search, i18n, dark mode out of the box.",
 "category": {
  "slug": "page-templates",
  "name": "Page and site templates"
 },
 "tags": [
  "Code library",
  "Open source"
 ],
 "styles": [
  "minimal"
 ],
 "logo_url": "https://agentgid.com/media/avatars/withastro.png",
 "logo_letter": "S",
 "links": {
  "repo": "https://github.com/withastro/starlight",
  "website": "https://starlight.astro.build",
  "api_docs": null
 },
 "preview": null,
 "verdicts": [
  {
   "key": "price",
   "label": "Price",
   "value": "Free",
   "status": "yes",
   "sub": "No paid plan",
   "quote": null,
   "note": "Fully free.",
   "source": {
    "label": "starlight.astro.build",
    "url": "https://starlight.astro.build"
   },
   "n": 1
  },
  {
   "key": "commercial",
   "label": "Commercial use",
   "value": "Yes",
   "status": "yes",
   "sub": "MIT",
   "quote": "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",
   "note": "MIT allows use in paid products and for commercial docs.",
   "source": {
    "label": "raw.githubusercontent.com",
    "url": "https://raw.githubusercontent.com/withastro/starlight/main/LICENSE"
   },
   "n": 2
  },
  {
   "key": "credit",
   "label": "Credit the author",
   "value": "Not needed",
   "status": "yes",
   "sub": "Keep the notice in code copies",
   "quote": "The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.",
   "note": "No credit on screen. Keep the license notice inside the code you ship.",
   "source": {
    "label": "raw.githubusercontent.com",
    "url": "https://raw.githubusercontent.com/withastro/starlight/main/LICENSE"
   },
   "n": 3
  },
  {
   "key": "agent_access",
   "label": "Agent access",
   "value": "npm package",
   "status": "info",
   "sub": "Installs without a key",
   "quote": null,
   "note": "An agent can install it by itself with npm install @astrojs/starlight. No key or account is needed.",
   "source": {
    "label": "github.com/withastro/starlight",
    "url": "https://github.com/withastro/starlight"
   },
   "n": 4
  }
 ],
 "license": {
  "name": "MIT",
  "url": "https://raw.githubusercontent.com/withastro/starlight/main/LICENSE",
  "summary": "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.",
  "pages_read": 1,
  "rules": [
   "Keep the MIT copyright notice in the code if you redistribute it.",
   "No visible credit on the site is required by the licence."
  ],
  "rows": [
   {
    "label": "Commercial use",
    "value": "Yes",
    "status": "yes",
    "quote": "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",
    "source": {
     "label": "raw.githubusercontent.com",
     "url": "https://raw.githubusercontent.com/withastro/starlight/main/LICENSE"
    },
    "note": null
   },
   {
    "label": "Credit",
    "value": "Not needed",
    "status": "yes",
    "quote": "The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.",
    "source": {
     "label": "raw.githubusercontent.com",
     "url": "https://raw.githubusercontent.com/withastro/starlight/main/LICENSE"
    },
    "note": null
   },
   {
    "label": "Inside your app or game",
    "value": "Can ship inside your app",
    "status": "yes",
    "quote": "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",
    "source": {
     "label": "raw.githubusercontent.com",
     "url": "https://raw.githubusercontent.com/withastro/starlight/main/LICENSE"
    },
    "note": null
   },
   {
    "label": "Pass the files on to your users",
    "value": "Allowed",
    "status": "yes",
    "quote": "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",
    "source": {
     "label": "raw.githubusercontent.com",
     "url": "https://raw.githubusercontent.com/withastro/starlight/main/LICENSE"
    },
    "note": null
   },
   {
    "label": "AI training",
    "value": "Not stated",
    "status": "unknown",
    "quote": null,
    "source": null,
    "note": null
   },
   {
    "label": "Bots and bulk downloads",
    "value": "Not stated",
    "status": "unknown",
    "quote": null,
    "source": null,
    "note": null
   }
  ],
  "checked_at": "2026-11-05",
  "commercial_use_page": "https://agentgid.com/assets/starlight/commercial-use/"
 },
 "overview": {
  "heading": "Starlight: a ready documentation website from Markdown files",
  "body": "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."
 },
 "uses": [
  {
   "title": "Documentation for your product",
   "text": "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.",
   "idea": false,
   "image": null
  },
  {
   "title": "A docs section on an existing site",
   "text": "If your website is already built with Astro, add a documentation part to it instead of running a second site on another address.",
   "idea": false,
   "image": null
  },
  {
   "title": "Help pages in several languages",
   "text": "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.",
   "idea": false,
   "image": null
  },
  {
   "title": "Search with no extra service",
   "text": "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.",
   "idea": false,
   "image": null
  },
  {
   "title": "A front page for the docs",
   "text": "Give the docs a wide welcome page without the side menu, with a big heading and buttons, like the Starlight home page itself.",
   "idea": false,
   "image": null
  },
  {
   "title": "An internal team handbook",
   "text": "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.",
   "idea": true,
   "image": null
  }
 ],
 "start": {
  "prompt": "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.",
  "install": "npm create astro@latest -- --template starlight",
  "install_note": "Create a new project from the Starlight template. You need Node.js 22.23.4 or newer for the current Astro.",
  "code": [
   {
    "tab": "Step 1",
    "intro": "Start the local preview, then add pages as Markdown files in src/content/docs/.",
    "source": "npm run dev"
   },
   {
    "tab": "Step 2",
    "intro": "For an Astro site you already have, add Starlight to it instead of starting a new project.",
    "source": "npx astro add starlight"
   }
  ]
 },
 "mistakes": [
  {
   "dont": "Adding @astrojs/starlight to astro.config.mjs only and expecting pages in src/content/docs/ to show up",
   "fix": "Also create src/content.config.ts with a docs collection that uses docsLoader() and docsSchema()",
   "why": "Starlight reads pages through Astro content collections; the create-astro template sets this up, a manual setup does not.",
   "dont_code": false,
   "fix_code": false
  },
  {
   "dont": "Testing the header search in npm run dev and concluding it is broken",
   "fix": "Run npm run build (and preview the build) before checking search",
   "why": "The search index is made at build time.",
   "dont_code": false,
   "fix_code": false
  },
  {
   "dont": "Expecting a sitemap without setting the site address",
   "fix": "Set site: 'https://your-domain' in astro.config.mjs",
   "why": "Starlight only generates the sitemap when it knows the site URL.",
   "dont_code": false,
   "fix_code": false
  },
  {
   "dont": "Leaving the Starlight version floating (^0.x) and updating Astro on its own",
   "fix": "Pin @astrojs/starlight exactly and update Starlight and Astro together with npx @astrojs/upgrade",
   "why": "It is beta software with frequent releases, and it requires a matching Astro version.",
   "dont_code": false,
   "fix_code": false
  },
  {
   "dont": "Deploying a server-rendered Starlight site to Cloudflare without extra settings",
   "fix": "Add the nodejs_compat compatibility flag to the Wrangler configuration",
   "why": "The Starlight docs name this flag for the Cloudflare adapter.",
   "dont_code": false,
   "fix_code": false
  }
 ],
 "agent": {
  "self_serve": true,
  "self_serve_text": "Agent installs a package or loads it from a CDN",
  "install": "npm install @astrojs/starlight",
  "repo": "https://github.com/withastro/starlight",
  "api_docs": null,
  "api_account": "Not needed. Everything runs on your side.",
  "get_files": "npm create astro@latest -- --template starlight; no account.",
  "formats": [
   "mdx",
   "astro"
  ],
  "limits": null,
  "mcp": null,
  "mcp_url": null,
  "credit_line": "Docs built with Starlight (MIT)",
  "rules_text": "- 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.\n  Connect: npm @astrojs/starlight.\n  Get files: npm create astro@latest -- --template starlight; no account (mdx, astro).\n  Not allowed: Needs Node.js\n  Rule: Keep the MIT copyright notice in the code if you redistribute it.\n  Rule: No visible credit on the site is required by the licence.\n  License: https://raw.githubusercontent.com/withastro/starlight/main/LICENSE (checked 2026-11-05; details: https://agentgid.com/assets/starlight/)",
  "agent_md": "https://agentgid.com/assets/starlight/agent.md",
  "card_json": "https://agentgid.com/assets/starlight/card.json"
 },
 "popularity": {
  "gid_score": 49,
  "stars": 9605,
  "downloads_7d": 2350184,
  "downloads_7d_label": "2.4M",
  "downloads_change_4w_pct": 46.2,
  "eco": "npm",
  "package": "@astrojs/starlight",
  "repo": "withastro/starlight",
  "agent_projects": 4,
  "agent_projects_total": 4817,
  "downloads_unconfirmed": false,
  "series": {
   "downloads_weekly": [
    [
     "2025-11-17",
     109940
    ],
    [
     "2025-11-24",
     100182
    ],
    [
     "2025-12-01",
     113108
    ],
    [
     "2025-12-08",
     113482
    ],
    [
     "2025-12-15",
     106273
    ],
    [
     "2025-12-22",
     63985
    ],
    [
     "2025-12-29",
     68518
    ],
    [
     "2026-01-05",
     118467
    ],
    [
     "2026-01-12",
     137372
    ],
    [
     "2026-01-19",
     156902
    ],
    [
     "2026-01-26",
     165076
    ],
    [
     "2026-02-02",
     189360
    ],
    [
     "2026-02-09",
     198290
    ],
    [
     "2026-02-16",
     185536
    ],
    [
     "2026-02-23",
     201919
    ],
    [
     "2026-03-02",
     206283
    ],
    [
     "2026-03-09",
     233452
    ],
    [
     "2026-03-16",
     257412
    ],
    [
     "2026-03-23",
     252944
    ],
    [
     "2026-03-30",
     265492
    ],
    [
     "2026-04-06",
     287416
    ],
    [
     "2026-04-13",
     288645
    ],
    [
     "2026-04-20",
     316379
    ],
    [
     "2026-04-27",
     383718
    ],
    [
     "2026-05-04",
     416494
    ],
    [
     "2026-05-11",
     425062
    ],
    [
     "2026-05-18",
     448407
    ],
    [
     "2026-05-25",
     433652
    ],
    [
     "2026-06-01",
     425952
    ],
    [
     "2026-06-08",
     467820
    ],
    [
     "2026-06-15",
     433497
    ],
    [
     "2026-06-22",
     454613
    ],
    [
     "2026-06-29",
     498365
    ],
    [
     "2026-07-06",
     552478
    ],
    [
     "2026-07-13",
     642281
    ],
    [
     "2026-07-20",
     674070
    ],
    [
     "2026-07-27",
     661381
    ],
    [
     "2026-08-03",
     707773
    ],
    [
     "2026-08-10",
     756868
    ],
    [
     "2026-08-17",
     804515
    ],
    [
     "2026-08-24",
     955266
    ],
    [
     "2026-08-31",
     1106031
    ],
    [
     "2026-09-07",
     779200
    ],
    [
     "2026-09-14",
     989414
    ],
    [
     "2026-09-21",
     1294001
    ],
    [
     "2026-09-28",
     1569501
    ],
    [
     "2026-10-05",
     1455186
    ],
    [
     "2026-10-12",
     1198130
    ],
    [
     "2026-10-19",
     1387018
    ],
    [
     "2026-10-26",
     2149280
    ],
    [
     "2026-11-02",
     2179831
    ],
    [
     "2026-11-09",
     2350184
    ]
   ],
   "stars": [
    [
     "2026-11-07",
     9530
    ],
    [
     "2026-11-08",
     9531
    ],
    [
     "2026-11-09",
     9533
    ],
    [
     "2026-11-10",
     9538
    ],
    [
     "2026-11-11",
     9547
    ],
    [
     "2026-11-12",
     9547
    ],
    [
     "2026-11-13",
     9557
    ],
    [
     "2026-11-14",
     9578
    ],
    [
     "2026-11-15",
     9585
    ],
    [
     "2026-11-16",
     9594
    ],
    [
     "2026-11-17",
     9605
    ]
   ]
  },
  "stars_flat_since": null,
  "updated_at": "2026-11-17"
 },
 "alternatives": [
  {
   "slug": "starlight",
   "name": "Starlight",
   "why": null,
   "current": true,
   "price": "Free",
   "commercial": {
    "value": "Commercial OK",
    "status": "yes"
   },
   "access": "npm"
  },
  {
   "slug": "docusaurus",
   "name": "Docusaurus",
   "why": "Pick Docusaurus when your team works in React and wants a docs site, a blog and a landing page in one ready template.",
   "current": false,
   "price": "Free",
   "commercial": {
    "value": "Commercial OK",
    "status": "yes"
   },
   "access": "npm"
  },
  {
   "slug": "vitepress",
   "name": "VitePress",
   "why": "Pick VitePress when your project already uses Vue and Vite and you want its default docs theme and home page layout.",
   "current": false,
   "price": "Free",
   "commercial": {
    "value": "Commercial OK",
    "status": "yes"
   },
   "access": "npm"
  },
  {
   "slug": "fumadocs",
   "name": "Fumadocs",
   "why": "Pick Fumadocs when the docs should live inside a Next.js or React Router app, including pages made from an OpenAPI file.",
   "current": false,
   "price": "Free",
   "commercial": {
    "value": "Commercial OK",
    "status": "yes"
   },
   "access": "npm"
  },
  {
   "slug": "bootstrap-examples",
   "name": "Bootstrap Examples",
   "why": "Official Bootstrap 5 example snippets and layouts: heroes, features, pricing, headers, footers, dashboards; one zip download.",
   "current": false,
   "price": "Free",
   "commercial": {
    "value": "Commercial OK",
    "status": "yes"
   },
   "access": "npm"
  },
  {
   "slug": "nuxt-ui",
   "name": "Nuxt UI",
   "why": "Vue/Nuxt UI library (125+ components, Reka UI + Tailwind) with page-level components and MIT starter templates: landing, SaaS, docs, dashboard.",
   "current": false,
   "price": "Free",
   "commercial": {
    "value": "Commercial OK",
    "status": "yes"
   },
   "access": "npm"
  }
 ],
 "faq": [
  {
   "q": "Do I need to know how to code?",
   "a": "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."
  },
  {
   "q": "Does search need a paid service?",
   "a": "No. Search is built in with Pagefind and needs no setup. Algolia DocSearch is an optional replacement through an official plugin."
  },
  {
   "q": "Can I add it to the Astro site I already have?",
   "a": "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/."
  },
  {
   "q": "Can I change how it looks?",
   "a": "Yes. Add your logo, use CSS and settings, and for bigger changes replace Starlight's own parts with your components."
  },
  {
   "q": "Can I use it for a paid product's docs?",
   "a": "Yes. It is MIT licensed, so paid and commercial use is allowed."
  }
 ],
 "at_a_glance": {
  "latest_version": "0.42.10",
  "last_release": "2026-11-13",
  "last_commit": "2026-11-17",
  "runtime": "Astro ^7.2.10 (peer) and Node.js 22.23.4+ (even-numbered versions only) for the current Astro 7.",
  "key_needed": false,
  "formats": "mdx, astro"
 },
 "good_to_know": [
  "Starlight is still marked as beta and changes often. Pin its version and read the change list before updating.",
  "Building the site needs Node.js 22.23.4 or newer; odd versions such as 23 are not supported by Astro.",
  "The Astro build tool sends anonymous usage data to the Astro team by default. You can turn this off with one setting.",
  "Search works on the built site. Build the site first, then try the search box.",
  "No account or key is needed. The docs pages are ready-made files, so any static hosting can serve them."
 ],
 "stack_snippets": [],
 "claims": [
  "On a first visit a reader downloads less than 50 KB of compressed data"
 ],
 "checked": {
  "license_read": "2026-11-05",
  "overview_checked": "2026-11-09",
  "numbers_updated": "2026-11-17",
  "sources": [
   {
    "label": "starlight.astro.build",
    "url": "https://starlight.astro.build/"
   },
   {
    "label": "starlight.astro.build/getting-started",
    "url": "https://starlight.astro.build/getting-started/"
   },
   {
    "label": "starlight.astro.build/manual-setup",
    "url": "https://starlight.astro.build/manual-setup/"
   },
   {
    "label": "starlight.astro.build/guides/site-search",
    "url": "https://starlight.astro.build/guides/site-search/"
   },
   {
    "label": "starlight.astro.build/guides/i18n",
    "url": "https://starlight.astro.build/guides/i18n/"
   },
   {
    "label": "starlight.astro.build/guides/sidebar",
    "url": "https://starlight.astro.build/guides/sidebar/"
   },
   {
    "label": "starlight.astro.build/guides/customization",
    "url": "https://starlight.astro.build/guides/customization/"
   },
   {
    "label": "starlight.astro.build/guides/pages",
    "url": "https://starlight.astro.build/guides/pages/"
   },
   {
    "label": "starlight.astro.build",
    "url": "https://starlight.astro.build/guides/overriding-components/"
   },
   {
    "label": "starlight.astro.build/environmental-impact",
    "url": "https://starlight.astro.build/environmental-impact/"
   },
   {
    "label": "starlight.astro.build/resources/showcase",
    "url": "https://starlight.astro.build/resources/showcase/"
   },
   {
    "label": "github.com/withastro/starlight",
    "url": "https://github.com/withastro/starlight"
   },
   {
    "label": "LICENSE on GitHub",
    "url": "https://github.com/withastro/starlight/blob/main/LICENSE"
   },
   {
    "label": "README on GitHub",
    "url": "https://github.com/withastro/starlight/blob/main/packages/starlight/README.md"
   },
   {
    "label": "npm: @astrojs/starlight/latest",
    "url": "https://registry.npmjs.org/@astrojs/starlight/latest"
   },
   {
    "label": "npm: astro/latest",
    "url": "https://registry.npmjs.org/astro/latest"
   },
   {
    "label": "docs.astro.build/en/install-and-setup",
    "url": "https://docs.astro.build/en/install-and-setup/"
   },
   {
    "label": "docs.astro.build/en/guides/deploy",
    "url": "https://docs.astro.build/en/guides/deploy/"
   },
   {
    "label": "astro.build/telemetry",
    "url": "https://astro.build/telemetry/"
   },
   {
    "label": "starlight.astro.build",
    "url": "https://starlight.astro.build"
   },
   {
    "label": "raw.githubusercontent.com",
    "url": "https://raw.githubusercontent.com/withastro/starlight/main/LICENSE"
   }
  ],
  "unverified": null
 },
 "user_reports": null,
 "url": "https://agentgid.com/assets/starlight/",
 "note": "Written by AgentGid from the official pages in checked.sources; quotes are copied from those pages. status: yes | cond | no | unknown | info. Prices and vendor claims are as reported on the checked date. Not legal advice."
}
