-
Notifications
You must be signed in to change notification settings - Fork 737
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
base: v2
Are you sure you want to change the base?
Conversation
|
❌ Deploy Preview for tauri-v2 failed.
|
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 |
5da0f98
to
cc99dc2
Compare
cc99dc2
to
796f971
Compare
796f971
to
eeb8e51
Compare
eeb8e51
to
9e86639
Compare
9e86639
to
6bab1d4
Compare
6bab1d4
to
619282d
Compare
619282d
to
85697d4
Compare
85697d4
to
46f9f8e
Compare
46f9f8e
to
c98962d
Compare
c98962d
to
4bd6216
Compare
4bd6216
to
736c44d
Compare
1e63c3c
to
de40eec
Compare
de40eec
to
1e9760b
Compare
1e9760b
to
003969a
Compare
003969a
to
2e26b86
Compare
2e26b86
to
da68132
Compare
da68132
to
bcdc20d
Compare
bcdc20d
to
b15fc73
Compare
b15fc73
to
4070ee4
Compare
4070ee4
to
90df76c
Compare
This PR contains the following updates:
0.29.2
->0.34.1
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 thecredits
configuration option.v0.34.0
Compare Source
Minor Changes
#2322
f14eb0c
Thanks @HiDeoo! - Groups all of Starlight's CSS declarations into a singlestarlight
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 defaultattrs
andcontent
values from head entries parsed using Starlight’s schema.Previously when adding
head
metadata via frontmatter or user config, Starlight would automatically add values forattrs
andcontent
if not provided. Now, these properties are leftundefined
.This makes it simpler to add tags in route middleware for example as you no longer need to provide empty values for
attrs
andcontent
: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 ofAstro.locals.starlightRoute.head
is compatible withattrs
andcontent
potentially beingundefined
.#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 tofalse
:Please update Starlight and Astro together:
#2322
f14eb0c
Thanks @HiDeoo! - Removes Shikicss-variables
theme fallback.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.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:
Patch Changes
77a1104
Thanks @delucis! - Fixes passing imported SVGs to thefrontmatter
prop of the<StarlightPage>
component in Astro ≥5.7.0v0.33.2
Compare Source
Patch Changes
#3090
fc3ffa8
Thanks @delucis! - Updates internal@astrojs/mdx
,@astrojs/sitemap
, andastro-expressive-code
dependencies#3109
b5cc1b4
Thanks @dhruvkb! - Updates Expressive Code to v0.41.1v0.33.1
Compare Source
Patch Changes
#3088
1885049
Thanks @HiDeoo! - Fixes a regression in Starlight version0.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 thesocial
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.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! - Makessocial
configuration more flexible.social
configuration option has changed syntax. You will need to update this inastro.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:#2927
c46904c
Thanks @HiDeoo! - Adds thehead
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 inAstro.locals.starlightRoute.head
.#2924⚠️ BREAKING CHANGE: Ensures that the
6a56d1b
Thanks @HiDeoo! -<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:
The rendered text would previously include a space between the badge and the text due to the trailing space automatically added by the component:
Such code will now render the badge and text without a space:
To fix this, you can add a space between the badge and the text:
#2727
7c8fa30
Thanks @techfg! - Updates mobile menu toggle styles to display a close icon while the menu is openPatch Changes
#2927
c46904c
Thanks @HiDeoo! - Fixes an issue where overriding the canonical URL of a page using thehead
configuration option orhead
frontmatter field would strip any other<link>
tags from the<head>
.#2927
c46904c
Thanks @HiDeoo! - Fixes an issue where generated canonical URLs would include a trailing slash when using thetrailingSlash
Astro option is set to'never'
.#3025
f87e9ac
Thanks @delucis! - Fixes Starlight’s autogenerated<meta name="twitter:site">
tags when a Twitter link is set insocial
config. Previously these incorrectly renderedcontent="/username"
and now correctly rendercontent="@​username"
.v0.32.6
Compare Source
Patch Changes
#3030
5bdf139
Thanks @trueberryless! - Updates the type of theisFallback
field in route data fromtrue
toboolean
, keeping it optional but allowingfalse
as a possible value.#3018
188b8cf
Thanks @trueberryless! - Adds validation for user configrouteMiddleware
so it does not conflict with Astro's middleware.v0.32.5
Compare Source
Patch Changes
#3021
e3f881e
Thanks @jsparkdev! - Updates Korean language support#3020
58e3e84
Thanks @ayoayco! - Add SourceHut social icon#3013
5b599dd
Thanks @oluwatobiss! - Adds Substack icon to social links listv0.32.4
Compare Source
Patch Changes
#2994
ca4ec8b
Thanks @XREvo! - Fixes default ranking of merged indexes when using multi-site search#2969
4682c7a
Thanks @webpro! - Add npm social iconv0.32.3
Compare Source
Patch Changes
#2955
77b6a41
Thanks @trueberryless! - Adds 5 new icons:figma
,sketch
,vim
,vscode
, andzed
.#2961
da57fab
Thanks @ematipico! - Adds 1 new icon:jetbrains
.v0.32.2
Compare Source
Patch Changes
#2926
c0170fd
Thanks @resoltico! - Adds Latvian language support#2918
790c000
Thanks @HiDeoo! - Fixes a trailing slash inconsistency in generated sidebar links when using thetrailingSlash: 'ignore'
Astro option (the default) between internal and auto-generated links. Starlight behavior for this configuration value is to use a trailing slash as many common hosting providers redirect to URLs with a trailing slash by default.v0.32.1
Compare Source
Patch Changes
ec5ca59
Thanks @HiDeoo! - Fixes an issue preventing the use of rewrites.v0.32.0
Compare Source
Minor Changes
#2390
f493361
Thanks @delucis! - Moves route data toAstro.locals
instead of passing it down via component propsPreviously, 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:
@astrojs/starlight/props
, which is now deprecated.Astro.props
to useAstro.locals.starlightRoute
instead.{...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
ed6f9fd
Thanks @HiDeoo! - Exposes theStarlightIcon
TypeScript type referencing the names of Starlight’s built-in icons.v0.31.0
Compare Source
Minor Changes
#2777
88f4214
Thanks @hippotastic! - Updatesastro-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
andremoveUnusedThemes
. It also adds new style variants to the optional collapsible sections plugin.See the Expressive Code release notes for full details.
#2736⚠️ BREAKING CHANGE: The minimum supported version of Astro is now 5.1.5
29a885b
Thanks @delucis! -Please update Astro and Starlight together:
#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 optionsThe 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 semanticvar(--sl-color-hairline)
for the page sidebar border instead ofvar(--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 theStarlightExpressiveCodeOptions
type#2708
442c819
Thanks @delucis! - Fixes colour contrast correction in code blocksv0.30.6
Compare Source
Patch Changes
#2722
0b206d3
Thanks @techfg! - Fixes display of long site title on mobile#2762
7ab1576
Thanks @HiDeoo! - Prevents the header title from being translated by automatic translation systems.v0.30.5
Compare Source
Patch Changes
#2757
e7b0e74
Thanks @HiDeoo! - Fixes a UI string translation issue for languages with a region subtag.#2760
aec9edd
Thanks @HiDeoo! - Adds 5 new icons:left-caret
,up-arrow
,down-arrow
,download
, andcloud-download
.v0.30.4
Compare Source
Patch Changes
#2747
474c27e
Thanks @bbag! - Ensures<Tab>
component toggling is stable when smooth scrolling is enabled via custom CSS#2740
0e169c9
Thanks @HiDeoo! - Fixes an issue preventing Pagefind to be disabled using thepagefind
frontmatter field.#2732
a10b466
Thanks @Sidnioulz! - Adds Storybook, Confluence and Jira social iconsv0.30.3
Compare Source
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 phonev0.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 titlev0.30.1
Compare Source
Patch Changes
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
8d5a4e8
Thanks @HiDeoo! - Adds support for Astro v5, drops support for Astro v4.Upgrade Astro and dependencies
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
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: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: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 modalv0.29.3
Compare Source
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>
componentConfiguration
📅 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.
This PR was generated by Mend Renovate. View the repository job log.