fix(deps): update dependency @astrojs/starlight to v0.31.0

[renovate]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
@astrojs/starlight (source)	0.23.1 -> 0.31.0

---

Release Notes

withastro/starlight (@​astrojs/starlight)

v0.31.0

Compare Source

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:

  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

v0.30.6

Compare Source

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.

v0.30.5

Compare Source

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.

v0.30.4

Compare Source

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

v0.30.3

Compare Source

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

v0.30.2

Compare Source

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

v0.30.1

Compare Source

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.

v0.30.0

Compare Source

Minor Changes

• #​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:

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.

Patch Changes

• #​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

v0.29.3

Compare Source

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

v0.29.2

Compare Source

Patch Changes

• #​2616 128cc51 Thanks @​delucis! - Fixes an edge case to correctly avoid a trailing slash when navigating from a root locale homepage to another language via Starlight’s language switcher when trailingSlash: 'never' is set

v0.29.1

Compare Source

Patch Changes

• #​2611 6059d96 Thanks @​HiDeoo! - Fixes a UI string type issue in projects with multiple data content collections.

• #​2606 10b15a7 Thanks @​delucis! - Makes <CardGrid> more resilient to complex child content on smaller viewports

• #​2605 ec7ab4f Thanks @​brianzelip! - Exposes SidebarPersister component in package exports for use in custom overrides

• #​2614 9a31980 Thanks @​HiDeoo! - Fixes an issue with custom pages using the <StarlightPage /> component and a custom sidebar missing highlighting for the active page and navigation links.

• #​2600 49aef17 Thanks @​jdevega! - Adds Backstage social icon

• #​2613 a73780f Thanks @​delucis! - Fixes support for sidebar frontmatter options in sidebar entries using slug or the string shorthand for internal links

v0.29.0

Compare Source

Minor Changes

• #​2551 154c8e3 Thanks @​hippotastic! - Updates the astro-expressive-code dependency to the latest version (0.38).

  The new version allows using ec.config.mjs to selectively override individual Expressive Code styles and settings provided by Starlight themes and plugins, speeds up Shiki language loading, and adds the config option expressiveCode.shiki.injectLangsIntoNestedCodeBlocks. See the Expressive Code release notes for full details.

• #​2252 6116db0 Thanks @​HiDeoo! - Improves build performance for sites with large sidebars

  This release adds a caching layer to Starlight’s sidebar generation logic, reducing the number of times sidebars need to be regenerated while building a site. Some benchmarks for projects with a complex sidebar saw builds complete more than 35% faster with this change.

• #​2503 a4c8edd Thanks @​HiDeoo! - Improves the accessibility of asides and tabs by removing some unnecessary HTML landmarks.

Patch Changes

• #​2579 241966b Thanks @​RafidMuhymin! - Adds social link icon for Nostr

v0.28.6

Compare Source

Patch Changes

• #​2565 236467b Thanks @​HiDeoo! - Fixes an issue with custom UI strings defined in YAML files not being loaded in some contexts.

v0.28.5

Compare Source

Patch Changes

• #​2546 bf42300 Thanks @​HiDeoo! - Fixes an issue where i18n content collection related errors, e.g. malformed JSON or YAML, would not be reported.

• #​2548 07673c8 Thanks @​HiDeoo! - Fixes a URL localization edge case. In projects without a root locale configured, slugs without a locale prefix did not fall back to the default locale as expected.

• #​2547 91e1dd7 Thanks @​HiDeoo! - Fixes a Firefox Markdown content rendering issue for text sentences separated by a line break.

• #​2524 1b46783 Thanks @​jsparkdev! - Fixes a broken link to Astro’s Docs in an error message

v0.28.4

Compare Source

Patch Changes

• #​2444 d585b3e Thanks @​HiDeoo! - Fixes a UI string translation issue for languages with a region subtag.

• #​2518 0f69db8 Thanks @​morinokami! - Updates Japanese UI translations

• #​2507 bd6ced5 Thanks @​HiDeoo! - Fixes a table of contents highlighting issue after resizing the window.

• #​2444 d585b3e Thanks @​HiDeoo! - Refactors various components to use the new built-in localization system to access translated UI strings.

v0.28.3

Compare Source

Patch Changes

• #​2408 0b4823d Thanks @​HiDeoo! - Fixes a link formatting issue when using the Astro build.format option set to file with a base.

• #​2380 7b451cf Thanks @​delucis! - Loosen Starlight’s i18n schema to pass through unknown keys

• #​2388 6bba3d8 Thanks @​HiDeoo! - Fixes a potential type-checking issue in Starlight projects.

• #​2443 a0f40b3 Thanks @​kevinzunigacuellar! - Fixes CSS issue where bottom padding is not applied in the search dialog.

v0.28.2

Compare Source

Patch Changes

• #​2377 a257b83 Thanks @​HiDeoo! - Fixes an issue with synced <Tabs> components containing nested <Tabs> causing tab panels to not render correctly.

v0.28.1

Compare Source

Patch Changes

• #​2334 79b9ade Thanks @​HiDeoo! - Fixes an issue with Expressive Code UI labels not displaying correctly.

v0.28.0

Compare Source

Minor Changes

• #​1923 5269aad Thanks @​HiDeoo! - Overhauls the built-in localization system which is now powered by the i18next library and available to use anywhere in your documentation website.

  See the “Using UI translations” guide to learn more about how to access built-in UI labels or your own custom strings in your project. Plugin authors can also use the new injectTranslations() helper to add or update translation strings.

  ⚠️ BREAKING CHANGE: The Astro.props.labels props has been removed from the props passed down to custom component overrides.

  If you are relying on Astro.props.labels (for example to read a built-in UI label), you will need to update your code to use the new Astro.locals.t() helper instead.

v0.27.1

Compare Source

Patch Changes

• #​2303 f92791a Thanks @​delucis! - Fixes resolution for the internal module Git virtual module in projects with special characters in the file path

v0.27.0

Compare Source

Minor Changes

• #​1255 6f3202b Thanks @​Fryuni! - Adds support for server-rendered Starlight pages.

  When building a project with hybrid or server output mode, a new prerender option on Starlight config can be set to false to make all Starlight pages be rendered on-demand:

  export default defineConfig({
    output: 'server',
    integrations: [
      starlight({
        prerender: false,
      }),
    ],
  });

Patch Changes

• #​2242 756e85e Thanks @​delucis! - Refactors the logic for persisting and restoring sidebar state across navigations for better performance on slow or busy devices

• #​1255 6f3202b Thanks @​Fryuni! - Improves performance of computing the last updated times from Git history.

  Instead of executing git for each docs page, it is now executed twice regardless of the number of pages.

• #​1255 6f3202b Thanks @​Fryuni! - Fixes last updated times on projects with custom srcDir

v0.26.4

Compare Source

Patch Changes

• #​2288 b15f725 Thanks @​matthewp! - Safely handle Zod errors

  Prevents bugs where errors without the .received props would through and cause builds to fail unnecessarily.

v0.26.3

Compare Source

Patch Changes

• #​2281 5062d30 Thanks @​HiDeoo! - Fixes a potential text rendering issue that could include extra whitespaces for text containing colons.

• #​2279 62d59e2 Thanks @​HiDeoo! - Fixes an issue with frontmatter schemas containing collection references used with the <StarlightPage /> component and an Astro version greater than 4.14.0.

v0.26.2

Compare Source

Patch Changes

• #​2273 746e0cd Thanks @​delucis! - Fixes type error when using Starlight with Astro v4.15

• #​2265 25b661e Thanks @​SeraphicRav! - Adds TikTok social icon

• #​2272 d1969dd Thanks @​o-az! - Adds new icon: jsr

• #​2250 c0a6166 Thanks @​HiDeoo! - Removes internal E2E tests from the package published to the npm registry.

• #​2253 72bc76a Thanks @​HiDeoo! - Fixes an issue preventing to use the class attribute in hero action link buttons.

v0.26.1

Compare Source

Patch Changes

• #​2219 74d4716 Thanks @​HiDeoo! - Fixes a sidebar persistence issue when navigating between pages with different sidebar content.

v0.26.0

Compare Source

Minor Changes

• #​1784 68f56a7 Thanks @​HiDeoo! - Adds <LinkButton> component for visually distinct and emphasized call to action links

• #​2150 9368494 Thanks @​delucis! - Adds state persistence across page navigations to the main site sidebar

• #​2087 caa84ea Thanks @​HiDeoo! - Adds persistence to synced <Tabs> so that a user's choices are reflected across page navigations.

• #​2051 ec3b579 Thanks @​HiDeoo! - Adds a guideline to the last step of the <Steps> component.

  If you want to preserve the previous behaviour and hide the guideline on final steps, you can add the following custom CSS to your site:

  /* Hide the guideline for the final step in <Steps> lists. */
  .sl-steps > li:last-of-type::after {
    background: transparent;
  }

• #​1784 68f56a7 Thanks @​HiDeoo! - Changes the hero component action button default variant from minimal to primary.

  ⚠️ BREAKING CHANGE: If you want to preserve the previous appearance, hero component action buttons previously declared without a variant will need to be updated to include the variant property with the value minimal.

  hero:
    actions:
      - text: View on GitHub
        link: https://github.com/astronaut/my-project
        icon: external
  +     variant: minimal

• #​2168 e044fee Thanks @​HiDeoo! - ⚠️ BREAKING CHANGE: Updates the <StarlightPage /> component sidebar prop to accept an array of SidebarItems like the main Starlight sidebar configuration in astro.config.mjs.

  This change simplifies the definition of sidebar items in the <StarlightPage /> component, allows for shared sidebar configuration between the global sidebar option and <StarlightPage /> component, and also enables the usage of autogenerated sidebar groups with the <StarlightPage /> component.
  If you are using the <StarlightPage /> component with a custom sidebar configuration, you will need to update the sidebar prop to an array of SidebarItem objects.

  For example, the following custom page with a custom sidebar configuration defines a “Resources” group with a “New” badge, a link to the “Showcase” page which is part of the docs content collection, and a link to the Starlight website:

v0.25.5

Compare Source

Patch Changes

• #​2171 c8258d7 Thanks @​delucis! - Improves build performance slightly for bigger sites

• #​2199 91557fd Thanks @​connorjs! - Adds Azure DevOps (azureDevOps) icon for use in social links.

v0.25.4

Compare Source

Patch Changes

• #​2155 8bed886 Thanks @​delucis! - Improves page load performance on slower devices

• #​2167 9ac7725 Thanks @​delucis! - Fixes an issue detecting the built-in locale when running Starlight in a web container environment on Firefox

• #​2166 4f12049 Thanks @​delucis! - Updates @astrojs/mdx, @astrojs/sitemap, astro-expressive-code, unified, and vfile dependencies to the latest version

v0.25.3

Compare Source

Patch Changes

• #​2154 0b381d5 Thanks @​mktbsh! - Updates <head> logic to deduplicate <link rel="canonical"> tags. This means that custom canonicals set via frontmatter now override the default canonical generated by Starlight.

• #​2157 6757d97 Thanks @​astrobot-houston! - Updates file tree icon mapping to correctly map .cjs and .mjs extensions in several contexts

• #​2156 904ad47 Thanks @​delucis! - Fixes builds for projects with a space in their pathname

• #​2137 703903b Thanks @​cevdetardaharan! - Removes twitter:title and twitter:description meta tags from <head>

v0.25.2

Compare Source

Patch Changes

• #​2126 ada51ee Thanks @​essential-randomness! - Adds support for markdown formatting in aside titles

• #​2135 9bbb969 Thanks @​oluwatobiss! - Adds Pinterest social icon

v0.25.1

Compare Source

Patch Changes

• #​2122 359a642 Thanks @​HiDeoo! - Fixes an i18n configuration issue for multilingual sites when using Astro’s i18n config with prefixDefaultLocale set to false.

• #​2107 61e223b Thanks @​sanabel-al-firdaws! - Updates Arabic UI translations

• #​2105 81f8a2c Thanks @​delucis! - Fixes an edge case in custom pagination link processing

  Custom link values for prev/next in page frontmatter are now always used as authored.
  Previously this was not the case in some edge cases such as for the first and final pages in the sidebar.

• #​2119 464685a Thanks @​evadecker! - Improves styling of <hr>, <blockquote>, and <code> within asides

v0.25.0

Compare Source

Minor Changes

• #​2025 47f32c1 Thanks @​HiDeoo! - Removes the / search shortcut for accessibility reasons.

  ⚠️ Potentially breaking change: The search.shortcutLabel UI string has been removed. If you were using this string in your custom UI, you will need to update your code.

• #​2064 c5b47cb Thanks @​SnowDingo! - Improves styling of Markdown tables to work better in different contexts, including against different background colours like when used in asides.

• #​2031 2bab648 Thanks @​delucis! - Makes sidebar entry parsing stricter in Starlight config

  ⚠️ Potentially breaking change: Previously Starlight would accept a sidebar entry that matched one of its expected shapes, even if it included additional properties. For example, including both link and items was considered valid, with items being ignored. Now, it is an error to include more than one of link, items, or autogenerate in a sidebar entry.

  If you see errors after updating, look for sidebar entries in the Starlight configuration in astro.config.mjs that include too many keys and remove the one that was previously ignored.

• #​1874 eeba06e Thanks @​lorenzolewis! - Adds a new syntax for specifying sidebar link items for internal links

  You can now specify an internal page using only its slug, either as a string, or as an object with a slug property:

  starlight({
    title: 'Docs with easier sidebars',
    sidebar: ['getting-started', { slug: 'guides/installation' }],
  });

  Starlight will use the linked page’s frontmatter to configure the sidebar link.

Patch Changes

• #​2081 f0181d2 Thanks @​andrii-bodnar! - Updates the Ukrainian UI translations

v0.24.5

Compare Source

Patch Changes

• #​2062 5ac0ac6 Thanks @​evadecker! - Increase theme and language select inline padding

• #​2056 87e9ad0 Thanks @​HiDeoo! - Fixes an issue preventing remark plugins injected by Starlight plugins to handle Markdown text and leaf directives.

• #​2063 3ee1a94 Thanks @​delucis! - Translate fileTree.directory and aside.* UI string into Norwegian (Bokmål).

• #​2054 dbfd3ee Thanks @​HiDeoo! - Fixes an issue when using the <StarlightPage> component in a custom page with a user-defined srcDir configuration.

v0.24.4

Compare Source

Patch Changes

• #​2038 87f3f92 Thanks @​dragomano! - Updates Russian UI translations

• #​2043 53f4cd4 Thanks @​playmr365! - Updates Czech UI translations

• #​2041 8af5a60 Thanks @​HiDeoo! - Fixes <Steps> numbering bug caused by Chrome v126 CSS counter rewrite

v0.24.3

Compare Source

Patch Changes

• #​2028 af81ad3 Thanks @​HiDeoo! - Fixes a search dialog height issue in Safari.

• #​2022 80f82b1 Thanks @​playmr365! - Updates Czech UI translations

v0.24.2

Compare Source

Patch Changes

• #​2008 40359c7 Thanks @​vnepogodin! - Add Slovak language UI translation.

• #​2004 0aa2f06 Thanks @​liruifengv! - Removes an outdated export in package.json

• #​2007 44ca490 Thanks @​delucis! - Updates internal dependencies

• #​1993 60165b2 Thanks @​HiDeoo! - Fixes an i18n configuration issue when using a single root locale.

v0.24.1

Compare Source

Patch Changes

• #​1978 a5ab8cd6 Thanks @​kylewlacy! - Add new social icon for Zulip

• #​1962 2ef19a94 Thanks @​torn4dom4n! - Updates Vietnamese UI translations

• #​1976 5a61f73c Thanks @​jsparkdev! - Updates Korean UI translations

• #​1987 [0b8a8439](https://redirect.github.co

---

Configuration

📅 Schedule: Branch creation - "every weekend" (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.