Skip to content

starlight

@astrojs/starlight@0.43.1
withastro/starlight

🌟 Build beautiful, accessible, high-performance documentation websites with Astro

Version of withastro/starlight you run

CompareView on GitHub

Breaking changes

What to check before upgrading, taken from the notes of the last 30 releases.

    • #4190 3f2336b Thanks @delucis! - ⚠️ BREAKING CHANGE: Adds support for any Astro scopedStyleStrategy configuration.
    • ⚠️ Potentially breaking change: If your project or theme plugin overrides the ThemeSelect component, check that it still works after updating. The global API previously used by theme select components has been removed and calling StarlightThemeProvider.updatePickers() will no longer work.
    • ⚠️ Potentially breaking change: If you use Starlight’s translation APIs directly, see i18next’s migration guide for details. We don’t expect any changes to impact Starlight users, but let us know if they do.
  • ⚠️ Potentially breaking change: If you use a theme plugin, custom styles, or component overrides targeting the MobileMenuToggle button or PageFrame components, you may need to adjust these for the new markup. The button is no longer wrapped in a ` custom element and no longer uses the aria-expanded attribute. Instead, you can use the .sl-menu-button class name to target the button and the :popover-open` pseudo-class to style the menu open state specifically.

    • ⚠️ BREAKING CHANGE: The following minimum versions are now required:
    • ⚠️ BREAKING CHANGE: This release drops official support for Chromium-based browsers prior to version 116 (released August 2023), Safari-based browsers prior to version 17.0 (released September 2023), and Firefox prior to version 125 (released April 2024). You can find a list of currently supported browsers and their versions using this browserslist query.
    • ⚠️ BREAKING CHANGE: Astro v6 is no longer supported. Make sure you update Astro and any other official integrations at the same time as updating Starlight:
    • ⚠️ BREAKING CHANGE: This release drops official support for Chromium-based browsers prior to version 111 (released 07 March 2023) and Safari-based browsers prior to version 16.4 (released 27 March 2023). You can find a list of currently supported browsers and their versions using this browserslist query.
    • #3951 1202dd4 Thanks @HiDeoo! - ⚠️ BREAKING CHANGE: The minimum supported version of Starlight is now 0.41.0

Release history

All releases on GitHub
BadgeLatest version of withastro/starlight[![version](/badge/withastro/starlight)](/p/withastro/starlight)

Patch Changes

  • #4396 46a5020 Thanks @trueberryless! - Fixes a regression where the icon of the `` component was rendered smaller than the icon of Markdown asides.

Full release notesCompare with previous