Subscribe
Sign in
Starlight by Astro — Build beautiful documentation websites with ease
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!
47
Replies
@fredkschott great work . we really love astro and actually used astro docs as the base for our new documentation overhaul! What is the relation and how similar are astro docs and astro starlight? is there a migration path? keep up the good work!
Great question @alew3! Starlight is definitely the successor to our original docs template, with a whole lot of extra features like theme support and internationalization built-in. Depending on how much you customized the original docs template, migration could be as simple as starting a new Starlight project and moving your Markdown files over.
We plan to migrate the official Astro documentation (https://docs.astro.build) to use Starlight as well, but our first priority was to get it out there so other teams could start building!
I love Astro and build a lot of docs sites… So looks like a near-perfect combination to me, especially in the growing field of what I term "dynamic docs". You can also see an early preview of Starlight on my livestream https://www.youtube.com/live/WqH...
Timely product!
Any documentation or guidelines on how to run Starlight sites in subdirectories?
@musharofchy Thanks! Would love to know about what you might use Starlight for?
We have a guide to adding Starlight to existing Astro sites that covers adding the site in a subdirectory: https://starlight.astro.build/ma...
And if you just want to deploy to a subpath, Astro’s base configuration option should have you covered: https://docs.astro.build/en/refe...
@sentry_co Hey André! You can check out the documentation here: https://starlight.astro.build/ge...
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.
Thanks @moingshaikh — glad you share our concern for building environmentally friendly products!
While not built in, Starlight is compatible with all major analytics tools. For example, our docs show how to add a Fathom Analytics tracking script to a Starlight site: https://starlight.astro.build/re...
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.
Just tried it out, really cool way to set up docs. I love the search functionality. It is not very heavy, but works just perfect.
Congrats on the launch!! I'm curious to know, how does Starlight handle internationalization (i18n)?
@felixhaberle Thanks! We provide translations for built-in UI like the search modal in 17 languages currently (always growing), make it easy to provide content in multiple languages and let your users switch between them, and have a fallback content system to support progressively translating your content — provide content first in your default language and users of other languages will see that until you provide a translation.
Kudos on the launch of Starlight! The inclusion of navigation, search, i18n, and more, alongside support for various technologies, is truly impressive. Plus, it being free and open source is fantastic.
I love Astro and build a lot of docs sites helpful for product i like it very much
Astro