Skip to content

fix(deps): update dependency @astrojs/starlight to v0.34.1 #3067

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.

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

Draft
wants to merge 1 commit into
base: v2
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Dec 14, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
@astrojs/starlight (source) 0.29.2 -> 0.34.1 age adoption passing confidence

Release Notes

withastro/starlight (@​astrojs/starlight)

v0.34.1

Compare Source

Patch Changes
  • #​3140 f6eb1d5 Thanks @​HiDeoo! - Fixes a text selection issue for heading with a clickable anchor link when using double or triple click to select text.

  • #​3148 dc8b6d5 Thanks @​HiDeoo! - Fixes a regression of the Starlight icon color when using the credits configuration option.

v0.34.0

Compare Source

Minor Changes
  • #​2322 f14eb0c Thanks @​HiDeoo! - Groups all of Starlight's CSS declarations into a single starlight cascade layer.

    This change allows for easier customization of Starlight's CSS as any custom unlayered CSS will override the default styles. If you are using cascade layers in your custom CSS, you can use the @layer CSS at-rule to define the order of precedence for different layers including the ones used by Starlight.

    We recommend checking your site’s appearance when upgrading to make sure there are no style regressions caused by this change.

  • #​3122 3a087d8 Thanks @​delucis! - Removes default attrs and content values from head entries parsed using Starlight’s schema.

    Previously when adding head metadata via frontmatter or user config, Starlight would automatically add values for attrs and content if not provided. Now, these properties are left undefined.

    This makes it simpler to add tags in route middleware for example as you no longer need to provide empty values for attrs and content:

    head.push({
      tag: 'style',
      content: 'div { color: red }'
    - attrs: {},
    });
    head.push({
      tag: 'link',
    - content: ''
      attrs: { rel: 'me', href: 'https://example.com' },
    });

    This is mostly an internal API but if you are overriding Starlight’s Head component or processing head entries in some way, you may wish to double check your handling of Astro.locals.starlightRoute.head is compatible with attrs and content potentially being undefined.

  • #​3033 8c19678 Thanks @​delucis! - Adds support for generating clickable anchor links for headings.

    By default, Starlight now renders an anchor link beside headings in Markdown and MDX content. A new <AnchorHeading> component is available to achieve the same thing in custom pages built using <StarlightPage>.

    If you want to disable this new Markdown processing set the markdown.headingLinks option in your Starlight config to false:

    starlight({
      title: 'My docs',
      markdown: {
        headingLinks: false,
      },
    }),

    ⚠️ BREAKING CHANGE: The minimum supported version of Astro is now v5.5.0.

    Please update Starlight and Astro together:

    npx @&#8203;astrojs/upgrade
  • #​2322 f14eb0c Thanks @​HiDeoo! - Removes Shiki css-variables theme fallback.

    ⚠️ BREAKING CHANGE:

    Previously, Starlight used to automatically provide a fallback theme for Shiki, the default syntax highlighter built into Astro if the configured Shiki theme was not github-dark.

    This fallback was only relevant when the default Starlight code block renderer, Expressive Code, was disabled and Shiki was used. Starlight no longer provides this fallback.

    If you were relying on this behavior, you now manually need to update your Astro configuration to use the Shiki css-variables theme to match the previous behavior.

    import { defineConfig } from 'astro/config';
    
    export default defineConfig({
    + markdown: {
    +   shikiConfig: {
    +     theme: 'css-variables',
    +   },
    + },
    });

    Additionally, you can use custom CSS to control the appearance of the code blocks. Here are the previously used CSS variables for the fallback theme:

    :root {
      --astro-code-foreground: var(--sl-color-white);
      --astro-code-background: var(--sl-color-gray-6);
      --astro-code-token-constant: var(--sl-color-blue-high);
      --astro-code-token-string: var(--sl-color-green-high);
      --astro-code-token-comment: var(--sl-color-gray-2);
      --astro-code-token-keyword: var(--sl-color-purple-high);
      --astro-code-token-parameter: var(--sl-color-red-high);
      --astro-code-token-function: var(--sl-color-red-high);
      --astro-code-token-string-expression: var(--sl-color-green-high);
      --astro-code-token-punctuation: var(--sl-color-gray-2);
      --astro-code-token-link: var(--sl-color-blue-high);
    }
Patch Changes
  • #​3118 77a1104 Thanks @​delucis! - Fixes passing imported SVGs to the frontmatter prop of the <StarlightPage> component in Astro ≥5.7.0

v0.33.2

Compare Source

Patch Changes

v0.33.1

Compare Source

Patch Changes
  • #​3088 1885049 Thanks @​HiDeoo! - Fixes a regression in Starlight version 0.33.0 that caused the description and links to language alternates for multilingual websites to be missing from the <head> of the page.

  • #​3065 463adf5 Thanks @​HiDeoo! - Updates the social configuration option TSDoc example to match the shape of the expected value.

v0.33.0

Compare Source

Minor Changes
  • #​3026 82deb84 Thanks @​HiDeoo! - Fixes a potential list styling issue if the last element of a list item is a <script> tag.

    ⚠️ BREAKING CHANGE:

    This release drops official support for Chromium-based browsers prior to version 105 (released 30 August 2022) and Firefox-based browsers prior to version 121 (released 19 December 2023). You can find a list of currently supported browsers and their versions using this browserslist query.

    With this release, Starlight-generated sites will still work fine on those older browsers except for this small detail in list item styling, but future releases may introduce further breaking changes for impacted browsers, including in patch releases.

  • #​3025 f87e9ac Thanks @​delucis! - Makes social configuration more flexible.

    ⚠️ BREAKING CHANGE: The social configuration option has changed syntax. You will need to update this in astro.config.mjs when upgrading.

    Previously, a limited set of platforms were supported using a shorthand syntax with labels built in to Starlight. While convenient, this approach was less flexible and required dedicated code for each social platform added.

    Now, you must specify the icon and label for each social link explicitly and you can use any of Starlight’s built-in icons for social links.

    The following example shows updating the old social syntax to the new:

    - social: {
    -   github: 'https://github.com/withastro/starlight',
    -   discord: 'https://astro.build/chat',
    - },
    + social: [
    +   { icon: 'github', label: 'GitHub', href: 'https://github.com/withastro/starlight' },
    +   { icon: 'discord', label: 'Discord', href: 'https://astro.build/chat' },
    + ],
  • #​2927 c46904c Thanks @​HiDeoo! - Adds the head route data property which contains an array of all tags to include in the <head> of the current page.

    Previously, the <Head> component was responsible for generating a list of tags to include in the <head> of the current page and rendering them.
    This data is now available as Astro.locals.starlightRoute.head instead and can be modified using route data middleware.
    The <Head> component now only renders the tags provided in Astro.locals.starlightRoute.head.

  • #​2924 6a56d1b Thanks @​HiDeoo! - ⚠️ BREAKING CHANGE: Ensures that the <Badge> and <Icon> components no longer render with a trailing space.

    In Astro, components that include styles render with a trailing space which can prevent some use cases from working as expected, e.g. when using such components inlined with text. This change ensures that the <Badge> and <Icon> components no longer render with a trailing space.

    If you were previously relying on that implementation detail, you may need to update your code to account for this change. For example, considering the following code:

    <Badge text="New" />
    Feature

    The rendered text would previously include a space between the badge and the text due to the trailing space automatically added by the component:

    New Feature
    

    Such code will now render the badge and text without a space:

    NewFeature
    

    To fix this, you can add a space between the badge and the text:

    - <Badge text="New" />Feature
    + <Badge text="New" /> Feature
  • #​2727 7c8fa30 Thanks @​techfg! - Updates mobile menu toggle styles to display a close icon while the menu is open

Patch Changes

v0.32.6

Compare Source

Patch Changes

v0.32.5

Compare Source

Patch Changes

v0.32.4

Compare Source

Patch Changes

v0.32.3

Compare Source

Patch Changes

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 @&#8203;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 @&#8203;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 "@&#8203;astrojs/starlight/loaders";
     import { docsSchema } from "@&#8203;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 "@&#8203;astrojs/starlight/loaders";
     import { docsSchema, i18nSchema } from "@&#8203;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

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.

@renovate renovate bot requested a review from a team as a code owner December 14, 2024 15:33
@renovate renovate bot added the dependencies Does it update a dependency? label Dec 14, 2024
Copy link
Contributor Author

renovate bot commented Dec 14, 2024

⚠️ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

  • any of the package files in this branch needs updating, or
  • the branch becomes conflicted, or
  • you click the rebase/retry checkbox if found above, or
  • you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: pnpm-lock.yaml
Scope: all 6 workspace projects
Progress: resolved 1, reused 0, downloaded 0, added 0
Progress: resolved 44, reused 0, downloaded 0, added 0
Progress: resolved 188, reused 0, downloaded 0, added 0
Progress: resolved 317, reused 0, downloaded 0, added 0
Progress: resolved 475, reused 0, downloaded 0, added 0
Progress: resolved 665, reused 0, downloaded 0, added 0
Progress: resolved 810, reused 0, downloaded 0, added 0
 ERR_PNPM_UNUSED_PATCH  The following patches were not used: @astrojs/[email protected]

Either remove them from "patchedDependencies" or update them to match packages in your dependencies.

Copy link

netlify bot commented Dec 14, 2024

Deploy Preview for tauri-v2 failed.

Name Link
🔨 Latest commit 90df76c
🔍 Latest deploy log https://app.netlify.com/sites/tauri-v2/deploys/680aa3db060b6b0008b0958f

@vasfvitor
Copy link
Contributor

vasfvitor commented Dec 14, 2024

https://github.com/HiDeoo/starlight-links-validator, https://github.com/HiDeoo/starlight-blog and possible others to upgrade to astro v5 and starlight 0.3

pending:

fix patch

@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from 5da0f98 to cc99dc2 Compare December 16, 2024 17:13
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to v0.30.1 fix(deps): update dependency @astrojs/starlight to v0.30.2 Dec 16, 2024
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from cc99dc2 to 796f971 Compare December 19, 2024 13:28
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to v0.30.2 fix(deps): update dependency @astrojs/starlight to v0.30.3 Dec 19, 2024
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from 796f971 to eeb8e51 Compare January 7, 2025 00:47
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to v0.30.3 fix(deps): update dependency @astrojs/starlight to v0.30.4 Jan 7, 2025
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from eeb8e51 to 9e86639 Compare January 7, 2025 15:55
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to v0.30.4 fix(deps): update dependency @astrojs/starlight to v0.30.5 Jan 7, 2025
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from 9e86639 to 6bab1d4 Compare January 10, 2025 21:30
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to v0.30.5 fix(deps): update dependency @astrojs/starlight to v0.30.6 Jan 10, 2025
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from 6bab1d4 to 619282d Compare January 13, 2025 13:03
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to v0.30.6 fix(deps): update dependency @astrojs/starlight to v0.31.0 Jan 13, 2025
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from 619282d to 85697d4 Compare January 19, 2025 09:48
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to v0.31.0 fix(deps): update dependency @astrojs/starlight to v0.31.1 Jan 19, 2025
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from 85697d4 to 46f9f8e Compare February 15, 2025 13:44
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to v0.31.1 fix(deps): update dependency @astrojs/starlight to v0.32.0 Feb 15, 2025
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from 46f9f8e to c98962d Compare February 20, 2025 01:49
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to v0.32.0 fix(deps): update dependency @astrojs/starlight to v0.32.1 Feb 20, 2025
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from c98962d to 4bd6216 Compare February 27, 2025 21:50
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to v0.32.1 fix(deps): update dependency @astrojs/starlight to v0.32.2 Feb 27, 2025
@github-project-automation github-project-automation bot moved this to 🪵 Backlog in Documentation Feb 27, 2025
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from 4bd6216 to 736c44d Compare March 5, 2025 16:48
@vasfvitor vasfvitor marked this pull request as draft March 5, 2025 17:09
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch 2 times, most recently from 1e63c3c to de40eec Compare March 18, 2025 16:48
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to v0.32.2 fix(deps): update dependency @astrojs/starlight to v0.32.3 Mar 18, 2025
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from de40eec to 1e9760b Compare March 21, 2025 15:41
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to v0.32.3 fix(deps): update dependency @astrojs/starlight to v0.32.4 Mar 21, 2025
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from 1e9760b to 003969a Compare March 26, 2025 19:54
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to v0.32.4 fix(deps): update dependency @astrojs/starlight to v0.32.5 Mar 26, 2025
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from 003969a to 2e26b86 Compare April 5, 2025 18:41
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to v0.32.5 fix(deps): update dependency @astrojs/starlight to v0.32.6 Apr 5, 2025
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from 2e26b86 to da68132 Compare April 7, 2025 17:31
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to v0.32.6 fix(deps): update dependency @astrojs/starlight to v0.33.0 Apr 7, 2025
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from da68132 to bcdc20d Compare April 11, 2025 14:33
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to v0.33.0 fix(deps): update dependency @astrojs/starlight to v0.33.1 Apr 11, 2025
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from bcdc20d to b15fc73 Compare April 14, 2025 16:05
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to v0.33.1 fix(deps): update dependency @astrojs/starlight to v0.33.2 Apr 14, 2025
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from b15fc73 to 4070ee4 Compare April 16, 2025 10:52
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to v0.33.2 fix(deps): update dependency @astrojs/starlight to v0.34.0 Apr 16, 2025
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from 4070ee4 to 90df76c Compare April 24, 2025 20:49
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to v0.34.0 fix(deps): update dependency @astrojs/starlight to v0.34.1 Apr 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Does it update a dependency?
Projects
Status: 🪵 Backlog
Development

Successfully merging this pull request may close these issues.

1 participant