Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update dependency @astrojs/starlight to ^0.32.0 #1629

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update dependency @astrojs/starlight to ^0.32.0 #1629

wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Mar 15, 2025 •
edited by kubevalet
Loading

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
@astrojs/starlight (source) ^0.28.2 -> ^0.32.0 age adoption passing confidence

Release Notes

withastro/starlight (@​astrojs/starlight)

v0.32.2

Compare Source

Patch Changes

v0.32.1

Compare Source

Patch Changes

v0.32.0

Compare Source

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:

v0.31.1

Compare Source

Patch Changes

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

v0.30.5

Compare Source

Patch Changes

v0.30.4

Compare Source

Patch Changes

v0.30.3

Compare Source

Patch Changes

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
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

v0.29.3

Compare Source

Patch Changes

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

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

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), 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.

This change is Reviewable

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
0 participants