Skip to content

Releases: withastro/starlight

@astrojs/[email protected]

19 Dec 10:31
30a37d3
Compare
Choose a tag to compare

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]

16 Dec 16:29
4fd272b
Compare
Choose a tag to compare

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]

14 Dec 12:34
0e419cc
Compare
Choose a tag to compare

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]

13 Dec 22:02
b023ab8
Compare
Choose a tag to compare

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

@astrojs/[email protected]

13 Dec 22:02
b023ab8
Compare
Choose a tag to compare

Major Changes

  • #2612 8d5a4e8 Thanks @HiDeoo! - ⚠️ BREAKING CHANGE: The minimum supported version of Starlight is now 0.30.0

    Please use the @astrojs/upgrade command to upgrade your project:

    npx @astrojs/upgrade

Patch Changes

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

@astrojs/[email protected]

13 Dec 22:02
b023ab8
Compare
Choose a tag to compare

Minor Changes

  • #2612 8d5a4e8 Thanks @HiDeoo! - ⚠️ BREAKING CHANGE: The minimum supported version of Starlight is now 0.30.0

    Please use the @astrojs/upgrade command to upgrade your project:

    npx @astrojs/upgrade

Patch Changes

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

@astrojs/[email protected]

13 Dec 22:01
b023ab8
Compare
Choose a tag to compare

Minor Changes

  • #2612 8d5a4e8 Thanks @HiDeoo! - ⚠️ BREAKING CHANGE: The minimum supported version of Starlight is now 0.30.0

    Please use the @astrojs/upgrade command to upgrade your project:

    npx @astrojs/upgrade

Patch Changes

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

@astrojs/[email protected]

11 Dec 19:44
0d1f8cb
Compare
Choose a tag to compare

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

@astrojs/[email protected]

19 Nov 17:55
b2bdef2
Compare
Choose a tag to compare

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

@astrojs/[email protected]

19 Nov 13:30
0889189
Compare
Choose a tag to compare

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