Starlight Changelog
Version 0.35.0
Minor Changes
-
#2261
778b743
Thanks @shubham-padia! - Adds support for using any of Starlight’s built-in icons in asides. -
#3272
e7fe267
Thanks @delucis! - Adds a newgenerateId
option to Starlight’sdocsLoader()
This enables overriding the default sluggifier used to convert content filenames to URLs.
-
#3276
3917b20
Thanks @delucis! - Excludes banner content from search resultsPreviously, content set in
banner
in page frontmatter was indexed by Starlight’s default search provider Pagefind. This could cause unexpected search results, especially for sites setting a common banner content on multiple pages. Starlight’s defaultBanner
component is now excluded from search indexing.This change does not impact
Banner
overrides using custom components. -
#3266
1161af0
Thanks @HiDeoo! - Adds support for custom HTML attributes on autogenerated sidebar links using theautogenerate.attrs
option. -
#3274
80ccff7
Thanks @HiDeoo! - Fixes an issue where some Starlight remark and rehype plugins were transforming Markdown and MDX content in non-Starlight pages.⚠️ BREAKING CHANGE:
Previously, some of Starlight’s remark and rehype plugins, most notably the plugin transforming Starlight’s custom Markdown syntax for rendering asides, were applied to all Markdown and MDX content. This included content from individual Markdown pages and content from content collections other than the
docs
collection used by Starlight.This change restricts the application of Starlight’s remark and rehype plugins to only Markdown and MDX content loaded using Starlight’s
docsLoader()
. If you were relying on this behavior, please let us know about your use case in the dedicated#starlight
channel in the Astro Discord or by opening an issue.
Patch Changes
-
#3266
1161af0
Thanks @HiDeoo! - Ensures invalid sidebar group configurations using theattrs
option are properly reported as a type error.Previously, invalid sidebar group configurations using the
attrs
option were not reported as a type error but only surfaced at runtime. This change is only a type-level change and does not affect the runtime behavior of Starlight which does not support theattrs
option for sidebar groups. -
#3274
80ccff7
Thanks @HiDeoo! - Prevents Starlight remark and rehype plugins from transforming Markdown and MDX content when using the AstrorenderMarkdown()
content loader API.