A Vue- and Vite-powered static site generator for building documentation and content sites from Markdown.
18.5K+21 this week2.7KTypeScriptMITWell maintainedUpdated 3 days ago
withastro/starlight
A documentation website framework built on Astro for creating fast, accessible docs sites from Markdown or MDX.
- Stars
- 9,530
- Forks
- 1,084
- Open issues
- 39
- Last commit
- yesterday
What is it?
Starlight is a framework for building documentation websites on top of Astro. It is aimed at teams that want a complete docs site without assembling the layout, navigation and search from scratch.
The project provides a ready-made documentation structure that Astro renders into a site. The Starlight documentation itself is built with Starlight, which serves as a working example of the framework in use.
The project is maintained by the Starlight contributors under the MIT license, with support through the Astro Discord and GitHub issues.
Key features
- 01Builds documentation sites on top of the Astro framework.
- 02Ships a complete documentation layout with navigation.
- 03Uses the Astro toolchain for static site output.
- 04Accepts documentation written as content files in the Astro content collection format.
Use cases
- Publishing a project's product or API documentation as a website.
- Building a team knowledge base or internal handbook.
- Creating a documentation site for an open-source library.
Quick start
- 1
Read the Starlight docs for setup instructions
Things to know
- The README gives no install commands, so setup details must be found in the external docs.
- Starlight is built on Astro, so you need to be comfortable with the Astro framework.
In collections
Topics
FAQ
- What is starlight?
- A documentation website framework built on Astro for creating fast, accessible docs sites from Markdown or MDX. Starlight is a framework for building documentation websites on top of Astro. It is aimed at teams that want a complete docs site without assembling the layout, navigation and search from scratch.
- Is starlight free to use? What license does it have?
- starlight is open source under the MIT license. Check the license terms before using it in commercial products.
- Is starlight still maintained?
- Actively maintained. The last commit to starlight was on Nov 6, 2026.
- What can I use starlight for?
- Publishing a project's product or API documentation as a website. Building a team knowledge base or internal handbook. Creating a documentation site for an open-source library.
- How do I install starlight?
- Read the Starlight docs for setup instructions
- Where can I get starlight?
- The source code and installation instructions are on GitHub: https://github.com/withastro/starlight
Summary generated by AI from the project's README. GitHub stats refresh daily.
Related projects
A Markdown wiki and documentation generator built on Next.js, with search, wiki links, backlinks and a graph view, output as static files.
11214TypeScriptMITWell maintainedUpdated 5 days ago
A documentation site generator that turns Markdown files into a website with no build step required.
31.6K+6 this week5.8KJavaScriptMITWell maintainedUpdated 2 days ago
Python documentation generator that builds HTML, PDF, EPUB and other output from reStructuredText or Markdown sources.
8.1K2.6KPythonOtherUpdated 6 days ago
A TypeScript docs framework that builds documentation sites from Markdown/MDX, with OpenAPI and GraphQL API doc generation.
1159TypeScriptMITUpdated 9 days ago
A scaffolder that generates an editable Astro documentation site into your repo, with agent-readable Markdown and llms.txt output built in.
1.8K+290 this week62TypeScriptMITWell maintainedUpdated 4 hours ago