Releases: withastro/starlight
@astrojs/[email protected]
Minor Changes
-
#3427
c3b2d0f
Thanks @delucis! - Fixes styling of labels that wrap across multiple lines in<Tabs>
component⚠️ Potentially breaking change: Tab labels now have a narrower line-height and additional vertical padding. If you have custom CSS targetting the<Tabs>
component, you may want to double check the visual appearance of your tabs when updating.If you want to preserve the previous styling, you can add the following custom CSS to your site:
.tab > [role='tab'] { line-height: var(--sl-line-height); padding-block: 0; }
-
#3380
3364af3
Thanks @HiDeoo! - Makes head entry parsing stricter in Starlight config and content frontmatter.⚠️ Potentially breaking change: Previously Starlight would accept a head entry for ameta
tag defining somecontent
which generates invalid HTML as<meta>
is a void element which cannot have any child nodes. Now, it is an error to define ameta
tag including somecontent
.If you see errors after updating, look for head entries in the Starlight configuration in the
astro.config.mjs
file or in the frontmatter of your content files that include acontent
property for ameta
tag. To fix the error, move thecontent
property to theattrs
object with at least an additional attribute to identify the kind of metadata it represents:head: { tag: 'meta', - content: 'foo', attrs: { name: 'my-meta', + content: 'foo', }, },
-
#3340
2018c31
Thanks @HiDeoo! - Adds missing vertical spacing between Markdown content and UI Framework components using client directives.⚠️ Potentially breaking change: By default, Starlight applies some vertical spacing (--sl-content-gap-y
) between Markdown content blocks. This change introduces similar spacing between Markdown content blocks and UI Framework components using client directives which was not present before.If you were relying on the previous behavior, you can manually override the spacing by manually specifying the top margin on the component using custom CSS, e.g. by relying on a CSS class to target the component.
.my-custom-component { margin-top: 0; }
Patch Changes
@astrojs/[email protected]
Patch Changes
-
#3416
fcc0633
Thanks @randomguy-2650! - Updates German UI translations to be more idiomatic. -
#1640
d1b3828
Thanks @hippotastic! - Refactors various internal systems, improving code quality and maintainability. -
#3421
97e8103
Thanks @andersk! - Removes an invalidvalue
attribute from the language and theme selectors -
#3422
9200fac
Thanks @andersk! - Refactors collapsible sidebar sections and “on this page” dropdown to use<span>
instead of<div>
@astrojs/[email protected]
Patch Changes
-
#3341
10f6fe2
Thanks @HiDeoo! - Prevents potential build issues with the Astro Cloudflare adapter due to the dependency on Node.js builtins. -
#3327
bf58c60
Thanks @delucis! - Fixes a routing bug for docs pages with a slug authored with non-normalized composition. This could occur for filenames containing diacritics in some circumstances, causing 404s.
@astrojs/[email protected]
@astrojs/[email protected]
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.
@astrojs/[email protected]
@astrojs/[email protected]
Minor Changes
- #2261
778b743
Thanks @shubham-padia! - Adds support for theicon
attribute in theaside
tag, allowing the use of any of Starlight’s built-in icons.
@astrojs/[email protected]
Patch Changes
- #3298
7bd02e3
Thanks @HiDeoo! - Fixes a potential issue withabsolutePathToLang()
plugin API not handling paths with spaces correctly.
@astrojs/[email protected]
Patch Changes
- #3293
88f0d34
Thanks @HiDeoo! - Fixes an issue preventing to override the slug of a page with theslug
frontmatter property using the/
value.