fix(deps): update astro & starlight packages #3306
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
^5.2.0
->^6.0.0
4.0.11
->4.0.12
0.29.2
->0.34.3
^0.2.0
->^0.3.0
^4.16.18
->^5.0.0
^0.6.0
->^0.8.0
^0.15.0
->^0.24.0
^0.13.0
->^0.16.0
^0.26.6
->^0.28.0
4.2.10
->4.6.4
^3.2.11
->^5.0.0
Release Notes
withastro/astro (@astrojs/markdown-remark)
v6.3.2
Patch Changes
3c3b492
]:v6.3.1
Patch Changes
91c9503
Thanks @ematipico! - Upgrade to shiki v3v6.3.0
Compare Source
Minor Changes
#13352
cb886dc
Thanks @delucis! - Adds support for a newexperimental.headingIdCompat
flagBy default, Astro removes a trailing
-
from the end of IDs it generates for headings ending withspecial characters. This differs from the behavior of common Markdown processors.
You can now disable this behavior with a new configuration flag:
This can be useful when heading IDs and anchor links need to behave consistently across your site
and other platforms such as GitHub and npm.
If you are using the
rehypeHeadingIds
plugin directly, you can also pass this new option:#13311
a3327ff
Thanks @chrisirhc! - Adds a new configuration option for Markdown syntax highlightingexcludeLangs
This option provides better support for diagramming tools that rely on Markdown code blocks, such as Mermaid.js and D2 by allowing you to exclude specific languages from Astro's default syntax highlighting.
This option allows you to avoid rendering conflicts with tools that depend on the code not being highlighted without forcing you to disable syntax highlighting for other code blocks.
The following example configuration will exclude highlighting for
mermaid
andmath
code blocks:Read more about this new option in the Markdown syntax highlighting configuration docs.
v6.2.1
Compare Source
Patch Changes
042d1de
]:v6.2.0
Compare Source
Minor Changes
#13254
1e11f5e
Thanks @p0lyw0lf! - Adds remote image optimization in MarkdownPreviously, an internal remark plugin only looked for images in
![]()
syntax that referred to a relative file path. This meant that only local images stored insrc/
were passed through to an internal rehype plugin that would transform them for later processing by Astro's image service.Now, the plugins recognize and transform both local and remote images using this syntax. Only authorized remote images specified in your config are transformed; remote images from other sources will not be processed.
While not configurable at this time, this process outputs two separate metadata fields (
localImagePaths
andremoteImagePaths
) which allow for the possibility of controlling the behavior of each type of image separately in the future.Patch Changes
1e11f5e
]:v6.1.0
Compare Source
Minor Changes
#12850
db252e0
Thanks @colinbate! - Adds support for TOML frontmatter in.md
and.mdx
filesAstro 5.2 automatically identifies the format of your Markdown and MDX frontmatter based on the delimiter used. With
+++
as a delimiter (instead of the---
YAML code fence), your frontmatter will automatically be recognized and parsed as TOML.This is useful for adding existing content files with TOML frontmatter to your project from another framework such as Hugo.
TOML frontmatter can also be used with content collections, and files with different frontmatter languages can live together in the same project.
No configuration is required to use TOML frontmatter in your content files. Your delimiter will indicate your chosen frontmatter language:
v6.0.2
Compare Source
Patch Changes
3d89e62
Thanks @LunaticMuch! - Upgrades theesbuild
version to matchvite
v6.0.1
Compare Source
Patch Changes
#12646
f13417b
Thanks @bluwy! - Avoids parsing frontmatter that are not at the top of a file#12570
87231b1
Thanks @GrimLink! - Removes trailing new line in code blocks to prevent generating a trailing empty<span />
tag#12664
a71e9b9
Thanks @bluwy! - Fixes frontmatter parsing if file is encoded in UTF8 with BOMv6.0.0
Compare Source
Major Changes
#11861
3ab3b4e
Thanks @bluwy! - Cleans up Astro-specific metadata attached tovfile.data
in Remark and Rehype plugins. Previously, the metadata was attached in different locations with inconsistent names. The metadata is now renamed as below:vfile.data.__astroHeadings
->vfile.data.astro.headings
vfile.data.imagePaths
->vfile.data.astro.imagePaths
The types of
imagePaths
has also been updated fromSet<string>
tostring[]
. Thevfile.data.astro.frontmatter
metadata is left unchanged.While we don't consider these APIs public, they can be accessed by Remark and Rehype plugins that want to re-use Astro's metadata. If you are using these APIs, make sure to access them in the new locations.
#12008
5608338
Thanks @Princesseuh! - Welcome to the Astro 5 beta! This release has no changes from the latest alpha of this package, but it does bring us one step closer to the final, stable release.Starting from this release, no breaking changes will be introduced unless absolutely necessary.
To learn how to upgrade, check out the Astro v5.0 upgrade guide in our beta docs site.
#11825
560ef15
Thanks @bluwy! - Updates return object ofcreateShikiHighlighter
ascodeToHast
andcodeToHtml
to allow generating either the hast or html string directly#11661
83a2a64
Thanks @bluwy! - Renames the following CSS variables theme color token names to better align with the Shiki v1 defaults:--astro-code-color-text
=>--astro-code-foreground
--astro-code-color-background
=>--astro-code-background
You can perform a global find and replace in your project to migrate to the new token names.
#11861
3ab3b4e
Thanks @bluwy! - RemovesInvalidAstroDataError
,safelyGetAstroData
, andsetVfileFrontmatter
APIs in favour ofisFrontmatterValid
Patch Changes
#12075
a19530e
Thanks @bluwy! - Parses frontmatter ourselvesUpdated dependencies [
827093e
]:withastro/astro (@astrojs/rss)
v4.0.12
Compare Source
Patch Changes
c947c28
Thanks @Adriel-M! - Fixes a missing type attribute when providing a XSLT stylesheetwithastro/starlight (@astrojs/starlight)
v0.34.3
Compare Source
Patch Changes
#3058
274cc06
Thanks @techfg! - Fixes display of focus indicator around site title#3181
449c822
Thanks @HiDeoo! - Fixes an issue where all headings in Markdown and MDX content were rendered with a clickable anchor link, even in non-Starlight pages.#3168
ca693fe
Thanks @jsparkdev! - Updates Korean langage support with improvements and missing translationsv0.34.2
Compare Source
Patch Changes
#3153
ea31f46
Thanks @SuperKXT! - Fixes hover styles for highlighted directory in FileTree component.#2905
b5232bc
Thanks @HiDeoo! - Fixes a potential issue for projects with dynamic routes added by an user, an Astro integration, or a Starlight plugin where some styles could end up being missing.#3165
80a7871
Thanks @KianNH! - IncreasesmaxBuffer
for an internalspawnSync()
call to support larger Git commit histories when using Starlight'slastUpdated
feature.#3158
d1f3c8b
Thanks @heisenberg0924! - Adds Hungarian language supportv0.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 betweenConfiguration
📅 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.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
This PR was generated by Mend Renovate. View the repository job log.