Product Thumbnail

Starlight by Astro

Build beautiful documentation websites with ease

Open Source
Education
Developer Tools
GitHub

Starlight is the web framework for building modern documentation websites. Comes with navigation, search, i18n, syntax highlighting, dark mode, and more included. Supports React, Svelte, Vue, Tailwind CSS, Markdown, and MDX. All free + open source!

Top comment

Hello PH! 👋 I’m Fred K. Schott, co-creator of Astro and one of the makers behind Starlight. I am so excited to show off what we've been working on. Starlight is a framework for building beautiful, fast, well-structured documentation websites. Over the past 6 months, the entire Astro core team — along with our amazing open-source community — has been hard at work building Starlight. Now, it's finally ready to share. Here are the highlights: 🧩 Starlight includes everything you'll need to launch. There is built-in search (powered by Pagefind), site navigation, i18n, a11y, SEO, clean typography, code highlighting, dark mode, automatic "edit in GitHub" links, and so much more. Focus on your content (Markdown, Markdoc, MDX) and let Starlight take care of the rest. 🏗️ Need to customize? Bring your favorite UI libraries and existing components into your codebase. Starlight is powered by Astro which means we support all of your favorite UI libraries like React, Vue, Svelte, Tailwind CSS, and more. 🧠 Most importantly, Starlight embodies 2+ years of learning and best-practices for what it takes to build great docs at Astro scale. In the last month alone we have merged 450+ Pull Requests into the Astro documentation site from a community of over 600 open source contributors. Starlight is the framework that we wish existed back when we got started! ♻️ But my favorite thing about Starlight is our commitment to reducing our environmental impact. It may sound small, but every website you visit costs energy to deliver to your device. And documentation websites get a LOT of hits. The good news is that Starlight is environmentally friendly, producing just 0.01g of CO₂ per pageview as measured by websitecarbon.com. That's greener than 99% of all websites tested! No other documentation framework matches our lightweight footprint, with some expending as much as 70x the CO₂ per page 🥵 We'd be thrilled to hear your feedback and answer any questions! And, if you have some documentation that you are putting off writing -- or if you already have a docs site that you're not totally satisfied with -- give Starlight a quick try. You'll be happy you did!

Comment highlights

Great launch, @fredkschott! What I love the most about Starlight beside it being opensource community is the fact that you guys have put sustainability in the process. I wish more makers consider the sustainability aspect of the product development to make the world a little more greener while making it better. I also have a question whether you are considering adding user analytics or tracking to provide insights on how users interact with the documentation? It could be helpful for product owners to understand which sections are most useful or if there are any pain points in their documentations.

Starlight" by Astro is like a cosmic symphony that takes you on a journey through the galaxies of K-pop. This song isn't just a mere track; it's a celestial experience. The ethereal vocals, combined with the pulsating beats, create an otherworldly sensation that's hard to put into words. The lyrics are like constellations of emotion, twinkling with heartfelt sentiments. Astro's performance in this song is nothing short of stellar, as they effortlessly blend harmonious melodies with their charismatic presence. It's a song that makes you feel like you're floating among the stars, lost in a world of dreams. "Starlight" is a testament to Astro's artistic evolution and their ability to create music that transcends boundaries. It's a celestial masterpiece that deserves to shine brightly in the K-pop galaxy.

Starlight by Astro's collaborative features are noteworthy. Can multiple team members work on different aspects of a case simultaneously?

"Starlight," a documentation solution powered by Astro. Starlight offers features like site navigation, search, internationalization, SEO, readable typography, code highlighting, and dark mode. It can be extended with various UI frameworks like React, Vue, Svelte, Solid, and more. It supports markup languages like Markdown, Markdoc, and MDX, with frontmatter validation using TypeScript. Astro, known for speed, serves as the foundation, allowing content to be pulled from anywhere and deployed across different platforms using preferred UI components.

If I have to go to git and start doing console commands, I don't consider something to be "easy."

Flawless product. For anyone obsessed with webperf this is the only Docs platform even worth considering. Don't waste your time with other platforms, you will just end up feeling the pain then having to move over to Starlight.

I can already tell this will be a game-changer. Kudos on the launch, you've definitely earned my upvote!

Timely product! Any documentation or guidelines on how to run Starlight sites in subdirectories?

This looks wonderful 🌟 I’ve been wanting to try Astro for a long time, but finally have a need for this one. Keep up the great work 😊