Changelog

0.33.2
Apr 14, 2025
🐞 Patch Changes
- #3090 fc3ffa8 Thanks @delucis! - Updates internal @astrojs/mdx, @astrojs/sitemap, and astro-expressive-code dependencies
- #3109 b5cc1b4 Thanks @dhruvkb! - Updates Expressive Code to v0.41.1
0.33.1
Apr 11, 2025
🐞 Patch Changes
- #3088 1885049 Thanks @HiDeoo! - Fixes a regression in Starlight version 0.33.0 that caused the description and links to language alternates for multilingual websites to be missing from the <head> of the page.
- #3065 463adf5 Thanks @HiDeoo! - Updates the social configuration option TSDoc example to match the shape of the expected value.
0.33.0
Apr 7, 2025
🍿 Minor Changes
- #3026 82deb84 Thanks @HiDeoo! - Fixes a potential list styling issue if the last element of a list item is a <script> tag.
  
  ⚠️ BREAKING CHANGE:
  
  This release drops official support for Chromium-based browsers prior to version 105 (released 30 August 2022) and Firefox-based browsers prior to version 121 (released 19 December 2023). You can find a list of currently supported browsers and their versions using this browserslist query.
  
  With this release, Starlight-generated sites will still work fine on those older browsers except for this small detail in list item styling, but future releases may introduce further breaking changes for impacted browsers, including in patch releases.
- #3025 f87e9ac Thanks @delucis! - Makes social configuration more flexible.
  
  ⚠️ BREAKING CHANGE: The social configuration option has changed syntax. You will need to update this in astro.config.mjs when upgrading.
  
  Previously, a limited set of platforms were supported using a shorthand syntax with labels built in to Starlight. While convenient, this approach was less flexible and required dedicated code for each social platform added.
  
  Now, you must specify the icon and label for each social link explicitly and you can use any of Starlight’s built-in icons for social links.
  
  The following example shows updating the old social syntax to the new:
  social: { github: 'https://github.com/withastro/starlight', discord: 'https://astro.build/chat', }, social: [ { icon: 'github', label: 'GitHub', href: 'https://github.com/withastro/starlight' }, { icon: 'discord', label: 'Discord', href: 'https://astro.build/chat' }, ],
- #2927 c46904c Thanks @HiDeoo! - Adds the head route data property which contains an array of all tags to include in the <head> of the current page.
  
  Previously, the <Head> component was responsible for generating a list of tags to include in the <head> of the current page and rendering them. This data is now available as Astro.locals.starlightRoute.head instead and can be modified using route data middleware. The <Head> component now only renders the tags provided in Astro.locals.starlightRoute.head.
- #2924 6a56d1b Thanks @HiDeoo! - ⚠️ BREAKING CHANGE: Ensures that the <Badge> and <Icon> components no longer render with a trailing space.
  
  In Astro, components that include styles render with a trailing space which can prevent some use cases from working as expected, e.g. when using such components inlined with text. This change ensures that the <Badge> and <Icon> components no longer render with a trailing space.
  
  If you were previously relying on that implementation detail, you may need to update your code to account for this change. For example, considering the following code:
  <Badge text="New" /> Feature
  The rendered text would previously include a space between the badge and the text due to the trailing space automatically added by the component:
  New Feature
  Such code will now render the badge and text without a space:
  NewFeature
  To fix this, you can add a space between the badge and the text:
  <Badge text="New" />Feature <Badge text="New" /> Feature
- #2727 7c8fa30 Thanks @techfg! - Updates mobile menu toggle styles to display a close icon while the menu is open
🐞 Patch Changes
- #2927 c46904c Thanks @HiDeoo! - Fixes an issue where overriding the canonical URL of a page using the head configuration option or head frontmatter field would strip any other <link> tags from the <head>.
- #2927 c46904c Thanks @HiDeoo! - Fixes an issue where generated canonical URLs would include a trailing slash when using the trailingSlash Astro option is set to 'never'.
- #3025 f87e9ac Thanks @delucis! - Fixes Starlight’s autogenerated <meta name="twitter:site"> tags when a Twitter link is set in social config. Previously these incorrectly rendered content="/username" and now correctly render content="@username".
0.32.6
Apr 5, 2025
🐞 Patch Changes
- #3030 5bdf139 Thanks @trueberryless! - Updates the type of the isFallback field in route data from true to boolean, keeping it optional but allowing false as a possible value.
- #3018 188b8cf Thanks @trueberryless! - Adds validation for user config routeMiddleware so it does not conflict with Astro’s middleware.
0.32.5
Mar 26, 2025
🐞 Patch Changes
- #3021 e3f881e Thanks @jsparkdev! - Updates Korean language support
- #3020 58e3e84 Thanks @ayoayco! - Add SourceHut social icon
- #3013 5b599dd Thanks @oluwatobiss! - Adds Substack icon to social links list
0.32.4
Mar 21, 2025
🐞 Patch Changes
- #2994 ca4ec8b Thanks @XREvo! - Fixes default ranking of merged indexes when using multi-site search
- #2969 4682c7a Thanks @webpro! - Add npm social icon
0.32.3
Mar 18, 2025
🐞 Patch Changes
- #2955 77b6a41 Thanks @trueberryless! - Adds 5 new icons: figma, sketch, vim, vscode, and zed.
- #2961 da57fab Thanks @ematipico! - Adds 1 new icon: jetbrains.
0.32.2
Feb 27, 2025
🐞 Patch Changes
- #2926 c0170fd Thanks @resoltico! - Adds Latvian language support
- #2918 790c000 Thanks @HiDeoo! - Fixes a trailing slash inconsistency in generated sidebar links when using the trailingSlash: 'ignore' Astro option (the default) between internal and auto-generated links. Starlight behavior for this configuration value is to use a trailing slash as many common hosting providers redirect to URLs with a trailing slash by default.
0.32.1
Feb 19, 2025
🐞 Patch Changes
- #2904 ec5ca59 Thanks @HiDeoo! - Fixes an issue preventing the use of rewrites.
0.32.0
Feb 15, 2025
🍿 Minor Changes
- #2390 f493361 Thanks @delucis! - Moves route data to Astro.locals instead of passing it down via component props
  
  ⚠️ Breaking change: Previously, all of Starlight’s templating components, including user or plugin overrides, had access to a data object for the current route via Astro.props. This data is now available as Astro.locals.starlightRoute instead.
  
  To update, refactor any component overrides you have:
  - Remove imports of @astrojs/starlight/props, which is now deprecated.
  - Update code that accesses Astro.props to use Astro.locals.starlightRoute instead.
  - Remove any spreading of {...Astro.props} into child components, which is no longer required.
  In the following example, a custom override for Starlight’s LastUpdated component is updated for the new style:
  --- import Default from '@astrojs/starlight/components/LastUpdated.astro'; import type { Props } from '@astrojs/starlight/props'; const { lastUpdated } = Astro.props; const { lastUpdated } = Astro.locals.starlightRoute; const updatedThisYear = lastUpdated?.getFullYear() === new Date().getFullYear(); --- {updatedThisYear && ( <Default {...Astro.props}><slot /></Default> <Default><slot /></Default> )}
  Community Starlight plugins may also need to be manually updated to work with Starlight 0.32. If you encounter any issues, please reach out to the plugin author to see if it is a known issue or if an updated version is being worked on.
- #2578 f895f75 Thanks @HiDeoo! - Deprecates the Starlight plugin setup hook in favor of the new config:setup hook which provides the same functionality.
  
  ⚠️ BREAKING CHANGE:
  
  The Starlight plugin setup hook is now deprecated and will be removed in a future release. Please update your plugins to use the new config:setup hook instead.
  export default { name: 'plugin-with-translations', hooks: { 'setup'({ config }) { 'config:setup'({ config }) { // Your plugin configuration setup code }, }, };
- #2578 f895f75 Thanks @HiDeoo! - Exposes the built-in localization system in the Starlight plugin config:setup hook.
  
  ⚠️ BREAKING CHANGE:
  
  This addition changes how Starlight plugins add or update translation strings used in Starlight’s localization APIs. Plugins previously using the injectTranslations() callback function from the plugin config:setup hook should now use the same function available in the i18n:setup hook.
  export default { name: 'plugin-with-translations', hooks: { 'config:setup'({ injectTranslations }) { 'i18n:setup'({ injectTranslations }) { injectTranslations({ en: { 'myPlugin.doThing': 'Do the thing', }, fr: { 'myPlugin.doThing': 'Faire le truc', }, }); }, }, };
- #2858 2df9d05 Thanks @XREvo! - Adds support for Pagefind’s multisite search features
- #2578 f895f75 Thanks @HiDeoo! - Adds a new HookParameters utility type to get the type of a plugin hook’s arguments.
- #2578 f895f75 Thanks @HiDeoo! - Adds a new useTranslations() callback function to the Starlight plugin config:setup hook to generate a utility function to access UI strings for a given language.
- #2578 f895f75 Thanks @HiDeoo! - Adds a new absolutePathToLang() callback function to the Starlight plugin config:setup to get the language for a given absolute file path.
🐞 Patch Changes
- #2848 9b32ba9 Thanks @HiDeoo! - Fixes styling of filter and metadata elements in Pagefind search UI.
0.31.1
Jan 17, 2025
🐞 Patch Changes
- #2805 ed6f9fd Thanks @HiDeoo! - Exposes the StarlightIcon TypeScript type referencing the names of Starlight’s built-in icons.
0.31.0
Jan 13, 2025
🍿 Minor Changes
- #2777 88f4214 Thanks @hippotastic! - Updates astro-expressive-code dependency to the latest version (0.40).
  
  This includes an update to the latest Shiki version (1.26.1), providing access to all current Shiki themes and syntax highlighting languages, and adding the config options shiki.engine, shiki.bundledLangs, shiki.langAlias and removeUnusedThemes. It also adds new style variants to the optional collapsible sections plugin.
  
  See the Expressive Code release notes for full details.
- #2736 29a885b Thanks @delucis! - ⚠️ BREAKING CHANGE: The minimum supported version of Astro is now 5.1.5
  
  Please update Astro and Starlight together:
  Terminal window
  npx @astrojs/upgrade
- #2728 e187383 Thanks @delucis! - Updates minimum Pagefind dependency to v1.3.0, sets new defaults for Pagefind’s ranking options, and adds support for manually configuring the ranking options
  
  The new ranking option defaults have been evaluated against Starlight’s own docs to improve the quality of search results. See “Customize Pagefind’s result ranking” for more details about how they work.
- #157 23bf960 Thanks @tony-sull! - Adds a print stylesheet to improve the appearance of Starlight docs pages when printed
- #2728 e187383 Thanks @delucis! - Fixes Pagefind logging to respect the Astro log level. When using Astro’s --verbose or --silent CLI flags, these are now respected by Pagefind as well.
🐞 Patch Changes
- #2792 412effb Thanks @dhruvkb! - Uses semantic var(--sl-color-hairline) for the page sidebar border instead of var(--sl-color-gray-6). This is visually the same as previously but makes it easier to override the hairline color consistently across a site.
- #2736 29a885b Thanks @delucis! - Updates internal dependencies @astrojs/sitemap and @astrojs/mdx to the latest versions
- #2782 d9d415b Thanks @delucis! - Fixes a documentation link in the JSDoc comment for the StarlightExpressiveCodeOptions type
- #2708 442c819 Thanks @delucis! - Fixes colour contrast correction in code blocks
0.30.6
Jan 10, 2025
🐞 Patch Changes
- #2722 0b206d3 Thanks @techfg! - Fixes display of long site title on mobile
- #2762 7ab1576 Thanks @HiDeoo! - Prevents the header title from being translated by automatic translation systems.
0.30.5
Jan 7, 2025
🐞 Patch Changes
- #2757 e7b0e74 Thanks @HiDeoo! - Fixes a UI string translation issue for languages with a region subtag.
- #2760 aec9edd Thanks @HiDeoo! - Adds 5 new icons: left-caret, up-arrow, down-arrow, download, and cloud-download.
0.30.4
Jan 6, 2025
🐞 Patch Changes
- #2747 474c27e Thanks @bbag! - Ensures <Tab> component toggling is stable when smooth scrolling is enabled via custom CSS
- #2740 0e169c9 Thanks @HiDeoo! - Fixes an issue preventing Pagefind to be disabled using the pagefind frontmatter field.
- #2732 a10b466 Thanks @Sidnioulz! - Adds Storybook, Confluence and Jira social icons
0.30.3
Dec 19, 2024
🐞 Patch Changes
- #2717 c5fcbb3 Thanks @delucis! - Fixes a list item spacing issue where line break elements (<br>) could receive a margin, breaking layout in Firefox
- #2724 02d7ac6 Thanks @dionysuzx! - Adds social link support for Farcaster
- #2635 ec4b851 Thanks @HiDeoo! - Fixes an issue where the language picker in multilingual sites could display the wrong language when navigating between pages with the browser back/forward buttons.
- #2726 e54ebd5 Thanks @techfg! - Adds icon for phone
0.30.2
Dec 16, 2024
🐞 Patch Changes
- #2702 02d16f3 Thanks @HiDeoo! - Fixes an issue with autogenerated sidebars when using Starlight with Astro’s new Content Layer API with directories containing spaces or special characters.
- #2704 fd16470 Thanks @delucis! - Fixes display of focus indicator around site title
0.30.1
Dec 14, 2024
🐞 Patch Changes
- #2688 5c6996c Thanks @HiDeoo! - Fixes an issue with autogenerated sidebars when using Starlight with Astro’s new Content Layer API where group names would be sluggified.
0.30.0
Dec 13, 2024
- #2612 8d5a4e8 Thanks @HiDeoo! - Adds support for Astro v5, drops support for Astro v4.
  
  Upgrade Astro and dependencies
  
  ⚠️ BREAKING CHANGE: Astro v4 is no longer supported. Make sure you update Astro and any other official integrations at the same time as updating Starlight:
  Terminal window
  npx @astrojs/upgrade
  Community Starlight plugins and Astro integrations may also need to be manually updated to work with Astro v5. If you encounter any issues, please reach out to the plugin or integration author to see if it is a known issue or if an updated version is being worked on.
  
  Update your collections
  
  ⚠️ BREAKING CHANGE: Starlight’s internal content collections, which organize, validate, and render your content, have been updated to use Astro’s new Content Layer API and require configuration changes in your project.
  1. Move the content config file. This file no longer lives within the src/content/config.ts folder and should now exist at src/content.config.ts.
  2. Edit the collection definition(s). To update the docs collection, a loader is now required:
    src/content.config.ts
    import { defineCollection } from "astro:content"; import { docsLoader } from "@astrojs/starlight/loaders"; import { docsSchema } from "@astrojs/starlight/schema"; export const collections = { docs: defineCollection({ schema: docsSchema() }), docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }), };
    If you are using the i18n collection to provide translations for additional languages you support or override our default labels, you will need to update the collection definition in a similar way and remove the collection type which is no longer available:
    src/content.config.ts
    import { defineCollection } from "astro:content"; import { docsLoader, i18nLoader } from "@astrojs/starlight/loaders"; import { docsSchema, i18nSchema } from "@astrojs/starlight/schema"; export const collections = { docs: defineCollection({ schema: docsSchema() }), docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }), i18n: defineCollection({ type: 'data', schema: i18nSchema() }), i18n: defineCollection({ loader: i18nLoader(), schema: i18nSchema() }), };
  3. Update other collections. To update any other collections you may have, follow the “Updating existing collections” section in the Astro 5 upgrade guide.
  If you are unable to make any changes to your collections at this time, including Starlight’s default docs and i18n collections, you can enable the legacy.collections flag to upgrade to v5 without updating your collections. This legacy flag exists to provide temporary backwards compatibility, and will allow you to keep your collections in their current state until the legacy flag is no longer supported.
- #2669 310df7d Thanks @aaronperezaguilera! - Adds Catalan UI translations
- #2664 62ff007 Thanks @HiDeoo! - Publishes provenance containing verifiable data to link a package back to its source repository and the specific build instructions used to publish it.
- #2670 0223b42 Thanks @aaronperezaguilera! - Adds Spanish UI translations for the Pagefind search modal
0.29.3
Dec 11, 2024
🐞 Patch Changes
- #2642 12750ae Thanks @dragomano! - Updates Russian UI translations
- #2656 4d543be Thanks @HiDeoo! - Improves error message when an invalid configuration or no configuration is provided to the Starlight integration.
- #2645 cf12beb Thanks @techfg! - Fixes support for favicon URLs that contain a search query and/or hash
- #2650 38db4ec Thanks @raviqqe! - Moves @types/js-yaml package to non-dev dependencies
- #2633 5adb720 Thanks @HiDeoo! - Fixes a VoiceOver issue with Safari where the content of a <script> element could be read before the sidebar content.
- #2663 34755f9 Thanks @astrobot-houston! - Adds a new seti:vite icon for Vite configuration files in the <FileTree> component

Changelog

🐞 Patch Changes

🐞 Patch Changes

🍿 Minor Changes

🐞 Patch Changes

🐞 Patch Changes

🐞 Patch Changes

🐞 Patch Changes

🐞 Patch Changes

🐞 Patch Changes

🐞 Patch Changes

🍿 Minor Changes

🐞 Patch Changes

🐞 Patch Changes

🍿 Minor Changes

🐞 Patch Changes

🐞 Patch Changes

🐞 Patch Changes

🐞 Patch Changes

🐞 Patch Changes

🐞 Patch Changes

🐞 Patch Changes

Upgrade Astro and dependencies

Update your collections

🐞 Patch Changes