fix(deps): update dependency @astrojs/starlight to ^0.40.0 #53
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "renovate/astrojs-starlight-0.x"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
This PR contains the following updates:
^0.30.0→^0.40.0Release Notes
withastro/starlight (@astrojs/starlight)
v0.40.0Compare Source
Minor Changes
#3923
edf2e6bThanks @Princesseuh! - Adds support for Astro 6.4 and the new Sätteri Markdown processor.It is now possible to opt into using Astro's 6.4 Sätteri Markdown processor by installing the
@astrojs/markdown-satteripackage and configuring it in yourastro.config.mjsfile:⚠️ BREAKING CHANGE: The minimum supported version of Astro is now v6.4.5.
Please update Starlight and Astro together:
Community Starlight plugins and Astro integrations may also need to be manually updated to work with Sätteri. 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.
Patch Changes
edf2e6bThanks @Princesseuh! - Updates Expressive Code to version 0.43.1.v0.39.3Compare Source
Patch Changes
#3910
dddf405Thanks @andreialba! - Improves Romanian UI translations#3924
02f2ce1Thanks @BouRock! - Improves Turkish UI translations#3928
11a7ed2Thanks @delucis! - Updates Pagefind to v1.5 and adds support for Pagefind’s newdiacriticSimilarityandmetaWeightsadvanced ranking options#3927
e944870Thanks @HiDeoo! - Refactors internal file path handling for Starlight content collections.v0.39.2Compare Source
Patch Changes
2d05e18Thanks @tats-u! - Fixes CSS selector fortext-autospacestyles in Chromium browsersv0.39.1Compare Source
Patch Changes
#3885
010eed1Thanks @ArmandPhilippot! - Fixes the version mentioned in an error message related to autogenerated sidebar groups support.#3887
b3c6990Thanks @delucis! - Adds 13 new icons:clock,desktop,mobile-android,window,database,server,code-branch,notes,question,question-circle,analytics,padlock, andsolidjs.v0.39.0Compare Source
Minor Changes
#3618
dcf6d09Thanks @HiDeoo! - ⚠️ BREAKING CHANGE: This release changes how autogenerated links work in Starlight’s sidebar configuration.If you have sidebar groups using the
autogeneratekey, you must now wrap that configuration in anitemsarray:This change unlocks the possibility to mix autogenerated links and other links in a single group, for example:
This release also updates the shape of autogenerated sidebar entries in route data. Autogenerated links and groups in
Astro.locals.starlightRoute.sidebarnow include anautogenerateobject with the configureddirectoryvalue:#3618
dcf6d09Thanks @HiDeoo! - ⚠️ BREAKING CHANGE: This release changes the default collapsed state of autogenerated sidebar subgroups.Autogenerated subgroups no longer inherit the
collapsedvalue from their parent group. They are now expanded by default unless explicitly configured withautogenerate.collapsed.If your sidebar configuration relies on a collapsed parent group to also collapse its autogenerated subgroups, update your configuration to set
autogenerate.collapsedtotrue:#3845
4d755f5Thanks @delucis! - Adds a<link rel="alternate" hreflang="x-default" href="...">tag pointing to the default locale in multilingual sites. Thex-defaultalternate is used as a signal of which language to fall back to if no other is available. Learn more in Google’s SEO localization docs.#3862
ec70630Thanks @itrew! - Makes spacing of items in nested lists more consistent#3872
417a66cThanks @tats-u! - Enables the CSS propertytext-autospacein Chinese and Japanese documents.If you would prefer to disable autospacing in Chinese and Japanese pages, you can add the following custom CSS to your site:
#3797
9764ebdThanks @delucis! - Avoids the risk of layout shift when users expand and collapse sidebar groupsThis release can introduce additional padding to the site sidebar on certain devices to reserve space for scrollbars. You may wish to inspect your site sidebar visually when upgrading.
If you would prefer to keep the previous styling, you can add the following custom CSS to your site:
#3858
6672c35Thanks @delucis! - Updatesi18next, used for Starlight’s localization APIs, from v23 to v26There should not be any user-facing changes from this update
v0.38.5Compare Source
Patch Changes
ccf6000, #387747451bcThanks @delucis! - Updates internal dependenciesv0.38.4Compare Source
Patch Changes
#3828
342038bThanks @MangelMaxime! - Fixes aside styling when used without any content#3853
563e11bThanks @delucis! - Fixes a type-checking issue for users on newer versions of TypeScriptv0.38.3Compare Source
Patch Changes
#3799
313611bThanks @JosefJezek! - Improves Czech UI translations#3770
6e7bed1Thanks @gameroman! - Adds examples to the inline documentation fortitlein the Starlight configuration object#3801
fedd48bThanks @delucis! - Fixes missing draft content warning in dev on pages using the hero layoutv0.38.2Compare Source
Patch Changes
#3759
f24ce99Thanks @MilesChou! - Fixes an issue where monolingual sites using a region-specific locale (e.g.,zh-TW) as the default would incorrectly display base language translations (e.g.,zhSimplified Chinese) instead of the region-specific ones (e.g.,zh-TWTraditional Chinese).#3768
a4c6c20Thanks @delucis! - Improves performance of sidebar generation for sites with very large sidebarsv0.38.1Compare Source
Patch Changes
fb955ffThanks @pyxelr! - Fixes a regression causing globaltableOfContentsconfig to be ignoredv0.38.0Compare Source
Minor Changes
0d2e7edThanks @HiDeoo! - Adds support for Astro v6, drops support for Astro v5.Upgrade Astro and dependencies
⚠️ BREAKING CHANGE: Astro v5 is no longer supported. Make sure you update Astro and any other official integrations at the same time as updating Starlight:
Community Starlight plugins and Astro integrations may also need to be manually updated to work with Astro v6. 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: Drops support for content collections backwards compatibility.
In Astro 5.x, projects could delay upgrading to the new Content Layer API introduced for content collections because of some existing automatic backwards compatibility that was not previously behind a flag. This meant that it was possible to upgrade from Astro 4 to Astro 5 without updating your content collections, even if you had not enabled the
legacy.collectionsflag. Projects would continue to build, and no errors or warnings would be displayed.Astro v6.0 now removes this automatic legacy content collections support, along with the
legacy.collectionsflag.If you experience content collections errors after updating to v6, check your project for any removed legacy features that may need updating to the Content Layer API. See the Starlight v0.30.0 upgrade guide for detailed instructions on upgrading legacy collections to the new Content Layer API.
If you are unable to make any changes to your collections at this time, including Starlight's default
docsandi18ncollections, you can enable thelegacy.collectionsBackwardsCompatflag to upgrade to v6 without updating your collections. This temporary flag preserves some legacy v4 content collections features, and will allow you to keep your collections in their current state until the legacy flag is no longer supported.#3704
375edccThanks @florian-lefebvre! - Fixes autocomplete for components exported from@astrojs/starlight/components/*⚠️ Potentially breaking change: This change moves some files used in Starlight’s component internals out of the
components/directory. Direct use of these files was not and is not officially supported. If you previously importedTableOfContents/starlight-toc.ts,TableOfContents/TableOfContentsList.astro,Icons.ts, orSidebarPersistState.ts, please review your code when updating.#3729
3642625Thanks @delucis! - Improves Starlight’s default body font stack to better support languages such as Chinese, Japanese, and Korean on Windows.For most users there should be no visible change.
If you would prefer to keep the previous font stack, you can add the following custom CSS to your site:
#3598
fff38d5Thanks @HiDeoo! - Makes hover styles consistent in Starlight’s navigation barPreviously, the social icon links and language/theme switchers in Starlight’s navigation bar, dimmed on hover.
After this change, they now increase in contrast on hover instead.
This matches hover behavior elsewhere, for example in the sidebar, table of contents, or search button.
⚠️ Potentially breaking change: this is a subtle change to the hover style colors.
If you want to preserve the previous styling, you can add the following custom CSS to your site:
v0.37.7Compare Source
Patch Changes
8a09b60Thanks @delucis! - Fixes an issue using components containing scripts inside Starlight’s steps component in versions of Astro >= 5.16.9v0.37.6Compare Source
Patch Changes
a562096Thanks @mschoeffmann! - Adds icons for Chrome, Edge, Firefox, and Safariv0.37.5Compare Source
Patch Changes
0ba556dThanks @controversial! - Excludes the accessible labels for heading anchor links from Pagefind resultsv0.37.4Compare Source
Patch Changes
#3534
703fab0Thanks @HiDeoo! - Fixes support for running builds whennpxis unavailable.Previously, Starlight would spawn a process to run the Pagefind search indexing binary using
npx. On platforms wherenpxisn’t available, this could cause issues. Starlight now runs Pagefind using its Node.js API to avoid a separate process. As a side effect, you may notice that logging during builds is now less verbose.#3656
a0e6368Thanks @delucis! - Fixes several edge cases in highlighting the current page heading in Starlight’s table of contents#3663
00cbf00Thanks @lines-of-codes! - Adds Thai language support#3658
ac79329Thanks @delucis! - Avoids adding redundantaria-current="false"attributes to sidebar entries#3382
db295c2Thanks @trueberryless! - Fixes an issue where the mobile table of contents is unable to find the first heading when a page has a tall banner.v0.37.3Compare Source
Patch Changes
292666cThanks @maxchang3! - Prevents unwanted font size adjustments on iOS after orientation changes.v0.37.2Compare Source
Patch Changes
9f4efc3Thanks @gerstenbergit! - Adds Greek language supportv0.37.1Compare Source
Patch Changes
30f6e7fThanks @delucis! - Fixes support for providing an absolute URL to Starlight’sfaviconconfiguration optionv0.37.0Compare Source
Minor Changes
#3491
28810f0Thanks @JusticeMatthew! - Changes text overflow styling in Markdown content⚠️ Potentially breaking change: This release switches the
overflow-wrapCSS style for common elements tobreak-word. In most cases, there should be little visual impact, but this change can impact how layouts with implicit sizing (such as tables) look, improving legibility in how words wrap.If you want to preserve the previous styling, you can add the following custom CSS to your site:
#3351
239698cThanks @HiDeoo! - Ensures that Starlight CSS layer order is predictable in custom pages using the<StarlightPage>component.Previously, due to how import order works in Astro, the
<StarlightPage>component had to be the first import in custom pages to set up cascade layers used internally by Starlight to manage the order of its styles.With this change, this restriction no longer applies and Starlight’s styles will be applied correctly regardless of the import order of the
<StarlightPage>component.#3521
ca7b771Thanks @shubham-padia! - Fixes an issue where a vertical scrollbar could be displayed on the Starlight<Tabs>component when zooming the page⚠️ Potentially breaking change: The
<Tabs>component no longer usesmargin-bottomandborder-bottomto highlight the current tab. This is now done with abox-shadow. If you have custom styling for your tabs, you may need to update it.If you want to preserve the previous styling, you can add the following custom CSS to your site:
#3549
1cf50ebThanks @jacobdalamb! - Updates the default sans-serif system font stack, dropping support for the-apple-systemandBlinkMacSystemFontfont names used in older browsers. These are no longer needed in browsers officially supported by Starlight.If you still need to support older browsers, you can add the following custom CSS to your site:
#3332
f61f99dThanks @HiDeoo! - Adds a newmarkdown.processedDirsconfiguration option to specify additional directories where files should be processed by Starlight’s Markdown pipeline.By default, Starlight’s processing only applies to Markdown and MDX content loaded using Starlight’s
docsLoader(). This new option allows to extend this processing to other directories, which can be useful if you are rendering content from a custom content collection using the<StarlightPage>component and expect Starlight’s Markdown processing to be applied to that content as well.v0.36.3Compare Source
Patch Changes
#3555
547dc30Thanks @Its-Just-Nans! - Improves the error message thrown when using a file in thepublic/directory with Starlight’scustomCssconfiguration option#3496
b78fda4Thanks @delucis! - Fixes invalid<head>output when configuration is missing:<meta property="og:description" />if Starlight’sdescriptionoption is unset<link rel="canonical" />and<meta property="og:url" />if Astro’ssiteoption is unset#3511
8727df1Thanks @astrobot-houston! - Updates theseti:gitlabicon to match latest version from Seti UI Iconsv0.36.2Compare Source
Patch Changes
#3500
7700456Thanks @delucis! - This is the first release published with OIDC trusted publishing.#3484
620fb38Thanks @gboubeta-uvigo! - Improves Spanish UI translationsv0.36.1Compare Source
Patch Changes
#3479
2fec483Thanks @gboubeta-uvigo! - Updates Galician UI translations#3457
c6c0c51Thanks @HiDeoo! - Deduplicates sitemap link tags in the head.When enabling sitemap in Starlight, a
<link rel="sitemap" href="/sitemap-index.xml">tag is automatically added to the head of each page. Manually specifying sitemap link tags using the Starlightheadconfiguration option or theheadfrontmatter field will now override the default sitemap link tag added by Starlight.This change ensures that users manually adding the
@astrojs/sitemapintegration to the Astrointegrationsarray for more fine-grained control over sitemap generation and also using thefilenameBaseintegration option can customize the sitemap link tag in the head.#3448
1fc7501Thanks @dionysuzx! - Enlarges the Farcaster icon to better match other social icons#3473
07204ddThanks @gboubeta! - Fixes a typo in Galician table of contents labelv0.36.0Compare Source
Minor Changes
#3427
c3b2d0fThanks @delucis! - Fixes styling of labels that wrap across multiple lines in<Tabs>component⚠️ Potentially breaking change: Tab labels now have a narrower line-height and additional vertical padding. If you have custom CSS targeting the
<Tabs>component, you may want to double check the visual appearance of your tabs when updating.If you want to preserve the previous styling, you can add the following custom CSS to your site:
#3380
3364af3Thanks @HiDeoo! - Makes head entry parsing stricter in Starlight config and content frontmatter.⚠️ Potentially breaking change: Previously Starlight would accept a head entry for a
metatag defining somecontentwhich generates invalid HTML as<meta>is a void element which cannot have any child nodes. Now, it is an error to define ametatag including somecontent.If you see errors after updating, look for head entries in the Starlight configuration in the
astro.config.mjsfile or in the frontmatter of your content files that include acontentproperty for ametatag. To fix the error, move thecontentproperty to theattrsobject with at least an additional attribute to identify the kind of metadata it represents:#3340
2018c31Thanks @HiDeoo! - Adds missing vertical spacing between Markdown content and UI Framework components using client directives.⚠️ Potentially breaking change: By default, Starlight applies some vertical spacing (
--sl-content-gap-y) between Markdown content blocks. This change introduces similar spacing between Markdown content blocks and UI Framework components using client directives which was not present before.If you were relying on the previous behavior, you can manually override the spacing by manually specifying the top margin on the component using custom CSS, e.g. by relying on a CSS class to target the component.
Patch Changes
a0d0670Thanks @andersk! - Fixes HTML validity in sidebar groups by ensuring<summary>is the first child of<details>v0.35.3Compare Source
Patch Changes
#3416
fcc0633Thanks @randomguy-2650! - Updates German UI translations to be more idiomatic.#1640
d1b3828Thanks @hippotastic! - Refactors various internal systems, improving code quality and maintainability.#3421
97e8103Thanks @andersk! - Removes an invalidvalueattribute from the language and theme selectors#3422
9200facThanks @andersk! - Refactors collapsible sidebar sections and “on this page” dropdown to use<span>instead of<div>v0.35.2Compare Source
Patch Changes
#3341
10f6fe2Thanks @HiDeoo! - Prevents potential build issues with the Astro Cloudflare adapter due to the dependency on Node.js builtins.#3327
bf58c60Thanks @delucis! - Fixes a routing bug for docs pages with a slug authored with non-normalized composition. This could occur for filenames containing diacritics in some circumstances, causing 404s.v0.35.1Compare Source
Patch Changes
4cf28f2Thanks @mniinio! - Adds Finnish language supportv0.35.0Compare Source
Minor Changes
#2261
778b743Thanks @shubham-padia! - Adds support for using any of Starlight’s built-in icons in asides.#3272
e7fe267Thanks @delucis! - Adds a newgenerateIdoption to Starlight’sdocsLoader()This enables overriding the default sluggifier used to convert content filenames to URLs.
#3276
3917b20Thanks @delucis! - Excludes banner content from search resultsPreviously, content set in
bannerin page frontmatter was indexed by Starlight’s default search provider Pagefind. This could cause unexpected search results, especially for sites setting a common banner content on multiple pages. Starlight’s defaultBannercomponent is now excluded from search indexing.This change does not impact
Banneroverrides using custom components.#3266
1161af0Thanks @HiDeoo! - Adds support for custom HTML attributes on autogenerated sidebar links using theautogenerate.attrsoption.#3274
80ccff7Thanks @HiDeoo! - Fixes an issue where some Starlight remark and rehype plugins were transforming Markdown and MDX content in non-Starlight pages.⚠️ BREAKING CHANGE:
Previously, some of Starlight’s remark and rehype plugins, most notably the plugin transforming Starlight's custom Markdown syntax for rendering asides, were applied to all Markdown and MDX content. This included content from individual Markdown pages and content from content collections other than the
docscollection used by Starlight.This change restricts the application of Starlight’s remark and rehype plugins to only Markdown and MDX content loaded using Starlight's
docsLoader(). If you were relying on this behavior, please let us know about your use case in the dedicated#starlightchannel in the Astro Discord or by opening an issue.Patch Changes
#3266
1161af0Thanks @HiDeoo! - Ensures invalid sidebar group configurations using theattrsoption are properly reported as a type error.Previously, invalid sidebar group configurations using the
attrsoption were not reported as a type error but only surfaced at runtime. This change is only a type-level change and does not affect the runtime behavior of Starlight which does not support theattrsoption for sidebar groups.#3274
80ccff7Thanks @HiDeoo! - Prevents Starlight remark and rehype plugins from transforming Markdown and MDX content when using the AstrorenderMarkdown()content loader API.v0.34.8Compare Source
Patch Changes
21fcd94Thanks @HiDeoo! - Fixes a regression in Starlight version0.34.5that caused multilingual sites with a default locale explicitly set torootto report a configuration error.v0.34.7Compare Source
Patch Changes
7bd02e3Thanks @HiDeoo! - Fixes a potential issue withabsolutePathToLang()plugin API not handling paths with spaces correctly.v0.34.6Compare Source
Patch Changes
88f0d34Thanks @HiDeoo! - Fixes an issue preventing to override the slug of a page with theslugfrontmatter property using the/value.v0.34.5Compare Source
Patch Changes
#3282
7680e87Thanks @alvinometric! - Moves padding of<main>element to a--sl-main-padCSS custom property to simplify setting custom values#3288
131371eThanks @HiDeoo! - Fixes a potential configuration issue for multilingual sites with a default language including a regional subtag.v0.34.4Compare Source
Patch Changes
#3205
95d124aThanks @sgalcheung! - Fixes an issue preventing to use the<StarlightPage>component when thedocscontent collection that Starlight uses does not exist.#3206
e6ea584Thanks @HiDeoo! - Fixes a text selection issue for heading with a clickable anchor link when using double click to select text in Chrome and Safari.#3233
3064c40Thanks @torn4dom4n! - Updates Vietnamese UI translations.#3248
16c1239Thanks @HiDeoo! - Prevents icons in the<Card>component from being shrunk in some narrow viewports.#3225
21b93b8Thanks @randomguy-2650! - Updates German UI translationsv0.34.3Compare Source
Patch Changes
#3058
274cc06Thanks @techfg! - Fixes display of focus indicator around site title#3181
449c822Thanks @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
ca693feThanks @jsparkdev! - Updates Korean language support with improvements and missing translationsv0.34.2Compare Source
Patch Changes
#3153
ea31f46Thanks @SuperKXT! - Fixes hover styles for highlighted directory in FileTree component.#2905
b5232bcThanks @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
80a7871Thanks @KianNH! - IncreasesmaxBufferfor an internalspawnSync()call to support larger Git commit histories when using Starlight'slastUpdatedfeature.#3158
d1f3c8bThanks @heisenberg0924! - Adds Hungarian language supportv0.34.1Compare Source
Patch Changes
#3140
f6eb1d5Thanks @HiDeoo! - Fixes a text selection issue for heading with a clickable anchor link when using double or triple click to select text.#3148
dc8b6d5Thanks @HiDeoo! - Fixes a regression of the Starlight icon color when using thecreditsconfiguration option.v0.34.0Compare Source
Minor Changes
#2322
f14eb0cThanks @HiDeoo! - Groups all of Starlight's CSS declarations into a singlestarlightcascade 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
@layerCSS 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
3a087d8Thanks @delucis! - Removes defaultattrsandcontentvalues from head entries parsed using Starlight’s schema.Previously when adding
headmetadata via frontmatter or user config, Starlight would automatically add values forattrsandcontentif 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
attrsandcontent:This is mostly an internal API but if you are overriding Starlight’s
Headcomponent or processing head entries in some way, you may wish to double check your handling ofAstro.locals.starlightRoute.headis compatible withattrsandcontentpotentially beingundefined.#3033
8c19678Thanks @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.headingLinksoption in your Starlight config tofalse:⚠️ BREAKING CHANGE: The minimum supported version of Astro is now v5.5.0.
Please update Starlight and Astro together:
#2322
f14eb0cThanks @HiDeoo! - Removes Shikicss-variablestheme 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-variablestheme 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
77a1104Thanks @delucis! - Fixes passing imported SVGs to thefrontmatterprop of the<StarlightPage>component in Astro ≥5.7.0v0.33.2Compare Source
Patch Changes
#3090
fc3ffa8Thanks @delucis! - Updates internal@astrojs/mdx,@astrojs/sitemap, andastro-expressive-codedependencies#3109
b5cc1b4Thanks @dhruvkb! - Updates Expressive Code to v0.41.1v0.33.1Compare Source
Patch Changes
#3088
1885049Thanks @HiDeoo! - Fixes a regression in Starlight version0.33.0that caused the description and links to language alternates for multilingual websites to be missing from the<head>of the page.#3065
463adf5Thanks @HiDeoo! - Updates thesocialconfiguration option TSDoc example to match the shape of the expected value.v0.33.0Compare Source
Minor Changes
#3026
82deb84Thanks @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
f87e9acThanks @delucis! - Makessocialconfiguration more flexible.⚠️ BREAKING CHANGE: The
socialconfiguration option has changed syntax. You will need to update this inastro.config.mjswhen 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
socialsyntax to the new:#2927
c46904cThanks @HiDeoo! - Adds theheadroute 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.headinstead and can be modified using route data middleware.The
<Head>component now only renders the tags provided inAstro.locals.starlightRoute.head.#2924
6a56d1bThanks @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:
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
7c8fa30Thanks @techfg! - Updates mobile menu toggle styles to display a close icon while the menu is openPatch Changes
#2927
c46904cThanks @HiDeoo! - Fixes an issue where overriding the canonical URL of a page using theheadconfiguration option orheadfrontmatter field would strip any other<link>tags from the<head>.#2927
c46904cThanks @HiDeoo! - Fixes an issue where generated canonical URLs would include a trailing slash when using thetrailingSlashAstro option is set to'never'.#3025
f87e9acThanks @delucis! - Fixes Starlight’s autogenerated<meta name="twitter:site">tags when a Twitter link is set insocialconfig. Previously these incorrectly renderedcontent="/username"and now correctly rendercontent="@​username".v0.32.6Compare Source
Patch Changes
#3030
5bdf139Thanks @trueberryless! - Updates the type of theisFallbackfield in route data fromtruetoboolean, keeping it optional but allowingfalseas a possible value.#3018
188b8cfThanks @trueberryless! - Adds validation for user configrouteMiddlewareso it does not conflict with Astro's middleware.v0.32.5Compare Source
Patch Changes
#3021
e3f881eThanks @jsparkdev! - Updates Korean language support#3020
58e3e84Thanks @ayoayco! - Add SourceHut social icon#3013
5b599ddThanks @oluwatobiss! - Adds Substack icon to social links listv0.32.4Compare Source
Patch Changes
#2994
ca4ec8bThanks @XREvo! - Fixes default ranking of merged indexes when using multi-site search#2969
4682c7aThanks @webpro! - Add npm social iconv0.32.3Compare Source
Patch Changes
#2955
77b6a41Thanks @trueberryless! - Adds 5 new icons:figma,sketch,vim,vscode, andzed.#2961
da57fabThanks @ematipico! - Adds 1 new icon:jetbrains.v0.32.2Compare Source
Patch Changes
#2926
c0170fdThanks @resoltico! - Adds Latvian language support#2918
790c000Thanks @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.1Compare Source
Patch Changes
ec5ca59Thanks @HiDeoo! - Fixes an issue preventing the use of rewrites.v0.32.0Compare Source
Minor Changes
#2390
f493361Thanks @delucis! - Moves route data toAstro.localsinstead 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.starlightRouteinstead.To update, refactor any component overrides you have:
@astrojs/starlight/props, which is now deprecated.Astro.propsto useAstro.locals.starlightRouteinstead.{...Astro.props}into child components, which is no longer required.In the following example, a custom override for Starlight’s
LastUpdatedcomponent is updated for the new style:Community Starlight plugins may also need to be manually updated to work with Starlight 0.32. If you encounter any issues, please reach out to the plugin author to see if it is a known issue or if an updated version is being worked on.
#2578
f895f75Thanks @HiDeoo! - Deprecates the Starlight pluginsetuphook in favor of the newconfig:setuphook which provides the same functionality.⚠️ BREAKING CHANGE:
The Starlight plugin
setuphook is now deprecated and will be removed in a future release. Please update your plugins to use the newconfig:setuphook instead.#2578
f895f75Thanks @HiDeoo! - Exposes the built-in localization system in the Starlight pluginconfig:setuphook.⚠️ BREAKING CHANGE:
This addition changes how Starlight plugins add or update translation strings used in Starlight’s localization APIs.
Plugins previously using the
injectTranslations()callback function from the pluginconfig:setuphook should now use the same function available in thei18n:setuphook.#2858
2df9d05Thanks @XREvo! - Adds support for Pagefind’s multisite search features#2578
f895f75Thanks @HiDeoo! - Adds a newHookParametersutility type to get the type of a plugin hook’s arguments.#2578
f895f75Thanks @HiDeoo! - Adds a newuseTranslations()callback function to the Starlight pluginconfig:setuphook to generate a utility function to access UI strings for a given language.#2578
f895f75Thanks @HiDeoo! - Adds a newabsolutePathToLang()callback function to the Starlight pluginconfig:setupto get the language for a given absolute file path.Patch Changes
9b32ba9Thanks @HiDeoo! - Fixes styling of filter and metadata elements in Pagefind search UI.v0.31.1Compare Source
Patch Changes
ed6f9fdThanks @HiDeoo! - Exposes theStarlightIconTypeScript type referencing the names of Starlight’s built-in icons.v0.31.0Compare Source
Minor Changes
#2777
88f4214Thanks @hippotastic! - Updatesastro-expressive-codedependency 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.langAliasandremoveUnusedThemes. It also adds new style variants to the optional collapsible sections plugin.See the Expressive Code release notes for full details.
#2736
29a885bThanks @delucis! - ⚠️ BREAKING CHANGE: The minimum supported version of Astro is now 5.1.5Please update Astro and Starlight together:
#2728
e187383Thanks @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
23bf960Thanks @tony-sull! - Adds a print stylesheet to improve the appearance of Starlight docs pages when printed#2728
e187383Thanks @delucis! - Fixes Pagefind logging to respect the Astro log level. When using Astro’s--verboseor--silentCLI flags, these are now respected by Pagefind as well.Patch Changes
#2792
412effbThanks @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
29a885bThanks @delucis! - Updates internal dependencies@astrojs/sitemapand@astrojs/mdxto the latest versions#2782
d9d415bThanks @delucis! - Fixes a documentation link in the JSDoc comment for theStarlightExpressiveCodeOptionstype#2708
442c819Thanks @delucis! - Fixes colour contrast correction in code blocksConfiguration
📅 Schedule: (in timezone Europe/Berlin)
🚦 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 has been generated by Mend Renovate.
Superseded by #73, which upgrades Starlight to 0.40 together with Astro 6 (coupled by peer dependencies) and fixes the resulting breaking changes (sidebar
items+socialarray). Closing.Pull request closed