Starlight 0.39 is Astro's official package for building fast, accessible documentation websites. This release introduces several new features, including more flexible autogenerated sidebar links, styling improvements, and enhanced support for multilingual sites.
Overview
Starlight has included support for generating sidebar navigation links from directories of content since its inception. With version 0.39, Starlight's autogenerated links can be slotted alongside any other link types, making it easy to combine autogeneration with different kinds of links. For example, you can now add one-off custom links alongside autogenerated ones.
What it does
The new release brings several improvements, including:
- More flexible autogenerated sidebar links, which can be combined with custom links
- Styling improvements, such as improved spacing of nested lists and a more stable sidebar
- Better multilingual sites, with improved multilingual SEO and text layout in Chinese and Japanese documentation
- Updated i18next library, which powers Starlight's localization APIs
To upgrade an existing Starlight site, use the automated @astrojs/upgrade CLI tool. This will update Starlight, Astro, and any other integrations you are using. The Starlight CHANGELOG provides migration guidance and full details of breaking changes.
Tradeoffs
While the new release brings several improvements, it also introduces some changes that may require updates to existing configurations. For example, existing autogenerated link groups in the sidebar need to be updated by wrapping the config in an items array.
The Astro core team and contributors have worked on this release, and the community is invited to provide feedback and ask questions on the Astro Discord.
In conclusion, Starlight 0.39 is a significant update that enhances the functionality and accessibility of documentation websites. With its improved autogenerated sidebar links, styling, and multilingual support, it is an essential tool for developers and teams building fast and accessible documentation websites.