@astrojs/[email protected]

Minor Changes

• #2822 e56586a Thanks @KianNH! - Adds a new clientOptionsModule plugin option to support configuring unserializable DocSearch options such as resultsFooterComponent().

  See “DocSearch configuration” in the Starlight docs for more details.

@astrojs/[email protected]

Patch Changes

• #2805 ed6f9fd Thanks @HiDeoo! - Exposes the StarlightIcon TypeScript type referencing the names of Starlight’s built-in icons.

@astrojs/[email protected]

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

@astrojs/[email protected]

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.

@astrojs/[email protected]

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.

@astrojs/[email protected]

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

@astrojs/[email protected]

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

@astrojs/[email protected]

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

@astrojs/[email protected]

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.

@astrojs/[email protected]

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