Skip to content

Releases: withastro/starlight

@astrojs/[email protected]

19 Sep 14:00
eb8ac77
Compare
Choose a tag to compare

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 a meta tag defining some content which generates invalid HTML as <meta> is a void element which cannot have any child nodes. Now, it is an error to define a meta tag including some content.

    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 a content property for a meta tag. To fix the error, move the content property to the attrs 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

  • #3423 a0d0670 Thanks @andersk! - Fixes HTML validity in sidebar groups by ensuring <summary> is the first child of <details>

@astrojs/[email protected]

13 Sep 13:24
266eed4
Compare
Choose a tag to compare

Patch Changes

@astrojs/[email protected]

29 Jul 09:50
cfd5185
Compare
Choose a tag to compare

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]

18 Jul 09:44
bec2c47
Compare
Choose a tag to compare

Patch Changes

@astrojs/[email protected]

16 Jul 14:08
7447fe5
Compare
Choose a tag to compare

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 new generateId option to Starlight’s docsLoader()

    This enables overriding the default sluggifier used to convert content filenames to URLs.

  • #3276 3917b20 Thanks @delucis! - Excludes banner content from search results

    Previously, 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 default Banner 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 the autogenerate.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 the attrs 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 the attrs option for sidebar groups.

  • #3274 80ccff7 Thanks @HiDeoo! - Prevents Starlight remark and rehype plugins from transforming Markdown and MDX content when using the Astro renderMarkdown() content loader API.

@astrojs/[email protected]

16 Jul 11:12
8d4d3bf
Compare
Choose a tag to compare

Patch Changes

  • #3306 21fcd94 Thanks @HiDeoo! - Fixes a regression in Starlight version 0.34.5 that caused multilingual sites with a default locale explicitly set to root to report a configuration error.

@astrojs/[email protected]

16 Jul 14:08
7447fe5
Compare
Choose a tag to compare

Minor Changes

  • #2261 778b743 Thanks @shubham-padia! - Adds support for the icon attribute in the aside tag, allowing the use of any of Starlight’s built-in icons.

@astrojs/[email protected]

15 Jul 17:22
411d109
Compare
Choose a tag to compare

Patch Changes

@astrojs/[email protected]

14 Jul 11:32
b191d23
Compare
Choose a tag to compare

Patch Changes

@astrojs/[email protected]

11 Jul 17:58
b00748c
Compare
Choose a tag to compare

Patch Changes

  • #3282 7680e87 Thanks @alvinometric! - Moves padding of <main> element to a --sl-main-pad CSS custom property to simplify setting custom values

  • #3288 131371e Thanks @HiDeoo! - Fixes a potential configuration issue for multilingual sites with a default language including a regional subtag.