Releases: withastro/starlight
@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.
@astrojs/[email protected]
@astrojs/[email protected]
@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.-
Move the content config file. This file no longer lives within the
src/content/config.ts
folder and should now exist atsrc/content.config.ts
. -
Edit the collection definition(s). To update the
docs
collection, aloader
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 collectiontype
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() }), };
-
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
andi18n
collections, you can enable thelegacy.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
@astrojs/[email protected]
@astrojs/[email protected]
@astrojs/[email protected]
@astrojs/[email protected]
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 newseti:vite
icon for Vite configuration files in the<FileTree>
component
@astrojs/[email protected]
@astrojs/[email protected]
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! - ExposesSidebarPersister
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. -
#2613
a73780f
Thanks @delucis! - Fixes support forsidebar
frontmatter options in sidebar entries usingslug
or the string shorthand for internal links