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

fix(deps): update dependency @astrojs/starlight to ^0.30.0 #143

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

fix(deps): update dependency @astrojs/starlight to ^0.30.0 #143

wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Aug 16, 2024 •
edited
Loading

This PR contains the following updates:

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

Release Notes

withastro/starlight (@​astrojs/starlight)

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

v0.28.6

Compare Source

Patch Changes
  • #​2565 236467b Thanks @​HiDeoo! - Fixes an issue with custom UI strings defined in YAML files not being loaded in some contexts.

v0.28.5

Compare Source

Patch Changes

  • #​2546 bf42300 Thanks @​HiDeoo! - Fixes an issue where i18n content collection related errors, e.g. malformed JSON or YAML, would not be reported.

  • #​2548 07673c8 Thanks @​HiDeoo! - Fixes a URL localization edge case. In projects without a root locale configured, slugs without a locale prefix did not fall back to the default locale as expected.

  • #​2547 91e1dd7 Thanks @​HiDeoo! - Fixes a Firefox Markdown content rendering issue for text sentences separated by a line break.

  • #​2524 1b46783 Thanks @​jsparkdev! - Fixes a broken link to Astro’s Docs in an error message

v0.28.4

Compare Source

Patch Changes

v0.28.3

Compare Source

Patch Changes

v0.28.2

Compare Source

Patch Changes
  • #​2377 a257b83 Thanks @​HiDeoo! - Fixes an issue with synced <Tabs> components containing nested <Tabs> causing tab panels to not render correctly.

v0.28.1

Compare Source

Patch Changes

v0.28.0

Compare Source

Minor Changes

  • #​1923 5269aad Thanks @​HiDeoo! - Overhauls the built-in localization system which is now powered by the i18next library and available to use anywhere in your documentation website.

    See the “Using UI translations” guide to learn more about how to access built-in UI labels or your own custom strings in your project. Plugin authors can also use the new injectTranslations() helper to add or update translation strings.

    ⚠️ BREAKING CHANGE: The Astro.props.labels props has been removed from the props passed down to custom component overrides.

    If you are relying on Astro.props.labels (for example to read a built-in UI label), you will need to update your code to use the new Astro.locals.t() helper instead.

v0.27.1

Compare Source

Patch Changes
  • #​2303 f92791a Thanks @​delucis! - Fixes resolution for the internal module Git virtual module in projects with special characters in the file path

v0.27.0

Compare Source

Minor Changes

  • #​1255 6f3202b Thanks @​Fryuni! - Adds support for server-rendered Starlight pages.

    When building a project with hybrid or server output mode, a new prerender option on Starlight config can be set to false to make all Starlight pages be rendered on-demand:

    export default defineConfig({
  output: 'server',
  integrations: [
    starlight({
      prerender: false,
    }),
  ],
});
Patch Changes

  • #​2242 756e85e Thanks @​delucis! - Refactors the logic for persisting and restoring sidebar state across navigations for better performance on slow or busy devices

  • #​1255 6f3202b Thanks @​Fryuni! - Improves performance of computing the last updated times from Git history.

    Instead of executing git for each docs page, it is now executed twice regardless of the number of pages.

  • #​1255 6f3202b Thanks @​Fryuni! - Fixes last updated times on projects with custom srcDir

v0.26.4

Compare Source

Patch Changes

  • #​2288 b15f725 Thanks @​matthewp! - Safely handle Zod errors

    Prevents bugs where errors without the .received props would through and cause builds to fail unnecessarily.

v0.26.3

Compare Source

Patch Changes

  • #​2281 5062d30 Thanks @​HiDeoo! - Fixes a potential text rendering issue that could include extra whitespaces for text containing colons.

  • #​2279 62d59e2 Thanks @​HiDeoo! - Fixes an issue with frontmatter schemas containing collection references used with the <StarlightPage /> component and an Astro version greater than 4.14.0.

v0.26.2

Compare Source

Patch Changes

v0.26.1

Compare Source

Patch Changes
  • #​2219 74d4716 Thanks @​HiDeoo! - Fixes a sidebar persistence issue when navigating between pages with different sidebar content.

v0.26.0

Compare Source

Minor Changes

  • #​1784 68f56a7 Thanks @​HiDeoo! - Adds <LinkButton> component for visually distinct and emphasized call to action links

  • #​2150 9368494 Thanks @​delucis! - Adds state persistence across page navigations to the main site sidebar

  • #​2087 caa84ea Thanks @​HiDeoo! - Adds persistence to synced <Tabs> so that a user's choices are reflected across page navigations.

  • #​2051 ec3b579 Thanks @​HiDeoo! - Adds a guideline to the last step of the <Steps> component.

    If you want to preserve the previous behaviour and hide the guideline on final steps, you can add the following custom CSS to your site:

    /* Hide the guideline for the final step in <Steps> lists. */
.sl-steps > li:last-of-type::after {
  background: transparent;
}

  • #​1784 68f56a7 Thanks @​HiDeoo! - Changes the hero component action button default variant from minimal to primary.

    ⚠️ BREAKING CHANGE: If you want to preserve the previous appearance, hero component action buttons previously declared without a variant will need to be updated to include the variant property with the value minimal.

    hero:
  actions:
    - text: View on GitHub
      link: https://github.com/astronaut/my-project
      icon: external
+     variant: minimal

  • #​2168 e044fee Thanks @​HiDeoo! - ⚠️ BREAKING CHANGE: Updates the <StarlightPage /> component sidebar prop to accept an array of SidebarItems like the main Starlight sidebar configuration in astro.config.mjs.

    This change simplifies the definition of sidebar items in the <StarlightPage /> component, allows for shared sidebar configuration between the global sidebar option and <StarlightPage /> component, and also enables the usage of autogenerated sidebar groups with the <StarlightPage /> component.
    If you are using the <StarlightPage /> component with a custom sidebar configuration, you will need to update the sidebar prop to an array of SidebarItem objects.

    For example, the following custom page with a custom sidebar configuration defines a “Resources” group with a “New” badge, a link to the “Showcase” page which is part of the docs content collection, and a link to the Starlight website:

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 added the renovate label Aug 16, 2024
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from 2bc3a12 to 38cd090 Compare September 6, 2024 22:51
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to ^0.26.0 fix(deps): update dependency @astrojs/starlight to ^0.27.0 Sep 6, 2024
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from 38cd090 to 853fac2 Compare September 18, 2024 08:27
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to ^0.27.0 fix(deps): update dependency @astrojs/starlight to ^0.28.0 Sep 18, 2024
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to ^0.28.0 fix(deps): update dependency @astrojs/starlight to ^0.29.0 Nov 8, 2024
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from 853fac2 to bc0559f Compare November 8, 2024 20:00
@renovate renovate bot force-pushed the renovate/astrojs-starlight-0.x branch from bc0559f to a1147e6 Compare December 14, 2024 01:25
@renovate renovate bot changed the title fix(deps): update dependency @astrojs/starlight to ^0.29.0 fix(deps): update dependency @astrojs/starlight to ^0.30.0 Dec 14, 2024
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
renovate
Projects
None yet
Milestone
No milestone
Development

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