Changelog
-
🍿 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:
p, h1, h2, h3, h4, h5, h6, code {overflow-wrap: anywhere;} -
#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:
starlight-tabs .tab {margin-bottom: -2px;}starlight-tabs .tab > [role='tab'] {border-bottom: 2px solid var(--sl-color-gray-5);box-shadow: none;}starlight-tabs .tab [role='tab'][aria-selected='true'] {border-color: var(--sl-color-text-accent);} -
#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:
:root {--sl-font-system: ui-sans-serif, system-ui, -apple-system,BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial,'Noto Sans', sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji','Segoe UI Symbol', 'Noto Color Emoji';} -
#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.
-
-
🐞 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:- Omits
<meta property="og:description" />if Starlight’sdescriptionoption is unset - Omits
<link rel="canonical" />and<meta property="og:url" />if Astro’ssiteoption is unset
- Omits
-
#3511
8727df1Thanks @astrobot-houston! - Updates theseti:gitlabicon to match latest version from Seti UI Icons
-
-
🐞 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 label
-
-
🍿 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 targetting 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:
.tab > [role='tab'] {line-height: var(--sl-line-height);padding-block: 0;} -
#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:head: {tag: 'meta',content: 'foo',attrs: {name: 'my-meta',content: 'foo',},}, -
#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.
.my-custom-component {margin-top: 0;}
🐞 Patch Changes
-
-
🐞 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>
-
-
🐞 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.
-
-
🍿 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.
-
-
🐞 Patch Changes
- #3298
7bd02e3Thanks @HiDeoo! - Fixes a potential issue withabsolutePathToLang()plugin API not handling paths with spaces correctly.
- #3298
-
🐞 Patch Changes
- #3293
88f0d34Thanks @HiDeoo! - Fixes an issue preventing to override the slug of a page with theslugfrontmatter property using the/value.
- #3293
-
🐞 Patch Changes
-
🐞 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 translations
-
-
🐞 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 langage support with improvements and missing translations
-
-
🐞 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 support
-
-
🍿 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: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
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: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:
Terminal window npx @astrojs/upgrade -
#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.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
-
-
🐞 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.
-
-
🍿 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: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
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 asAstro.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:
<Badge text="New" />FeatureThe rendered text would previously include a space between the badge and the text due to the trailing space automatically added by the component:
New FeatureSuch code will now render the badge and text without a space:
NewFeatureTo fix this, you can add a space between the badge and the text:
<Badge text="New" />Feature<Badge text="New" /> Feature -
#2727
7c8fa30Thanks @techfg! - Updates mobile menu toggle styles to display a close icon while the menu is open
🐞 Patch 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".
-
-
🐞 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.
-
-
🐞 Patch Changes
-
#3021
e3f881eThanks @jsparkdev! - Updates Korean language support -
#3013
5b599ddThanks @oluwatobiss! - Adds Substack icon to social links list
-
-
🐞 Patch Changes
-
#2955
77b6a41Thanks @trueberryless! - Adds 5 new icons:figma,sketch,vim,vscode, andzed. -
#2961
da57fabThanks @ematipico! - Adds 1 new icon:jetbrains.
-
-
🐞 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.
-
-
🍿 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 asAstro.locals.starlightRouteinstead.To update, refactor any component overrides you have:
- Remove imports of
@astrojs/starlight/props, which is now deprecated. - Update code that accesses
Astro.propsto useAstro.locals.starlightRouteinstead. - Remove any spreading of
{...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:---import Default from '@astrojs/starlight/components/LastUpdated.astro';import type { Props } from '@astrojs/starlight/props';const { lastUpdated } = Astro.props;const { lastUpdated } = Astro.locals.starlightRoute;const updatedThisYear = lastUpdated?.getFullYear() === new Date().getFullYear();---{updatedThisYear && (<Default {...Astro.props}><slot /></Default><Default><slot /></Default>)}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.
- Remove imports of
-
#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.export default {name: 'plugin-with-translations',hooks: {'setup'({ config }) {'config:setup'({ config }) {// Your plugin configuration setup code},},}; -
#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.export default {name: 'plugin-with-translations',hooks: {'config:setup'({ injectTranslations }) {'i18n:setup'({ injectTranslations }) {injectTranslations({en: {'myPlugin.doThing': 'Do the thing',},fr: {'myPlugin.doThing': 'Faire le truc',},});},},}; -
#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
-
-
🐞 Patch Changes
- #2805
ed6f9fdThanks @HiDeoo! - Exposes theStarlightIconTypeScript type referencing the names of Starlight’s built-in icons.
- #2805
-
🍿 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:
Terminal window npx @astrojs/upgrade -
#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 blocks
-
-
🐞 Patch Changes
-
#2747
474c27eThanks @bbag! - Ensures<Tab>component toggling is stable when smooth scrolling is enabled via custom CSS -
#2740
0e169c9Thanks @HiDeoo! - Fixes an issue preventing Pagefind to be disabled using thepagefindfrontmatter field. -
#2732
a10b466Thanks @Sidnioulz! - Adds Storybook, Confluence and Jira social icons
-
-
🐞 Patch Changes
-
#2717
c5fcbb3Thanks @delucis! - Fixes a list item spacing issue where line break elements (<br>) could receive a margin, breaking layout in Firefox -
#2724
02d7ac6Thanks @dionysuzx! - Adds social link support for Farcaster -
#2635
ec4b851Thanks @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.
-
-
-
#2612
8d5a4e8Thanks @HiDeoo! - Adds support for Astro v5, drops support for Astro v4.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:
Terminal window npx @astrojs/upgradeCommunity 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.
-
Move the content config file. This file no longer lives within the
src/content/config.tsfolder and should now exist atsrc/content.config.ts. -
Edit the collection definition(s). To update the
docscollection, aloaderis 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
i18ncollection 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 collectiontypewhich 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() }),}; -
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
docsandi18ncollections, you can enable thelegacy.collectionsflag 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. -
-
#2669
310df7dThanks @aaronperezaguilera! - Adds Catalan UI translations -
#2664
62ff007Thanks @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
0223b42Thanks @aaronperezaguilera! - Adds Spanish UI translations for the Pagefind search modal
-
-
🐞 Patch Changes
-
#2642
12750aeThanks @dragomano! - Updates Russian UI translations -
#2656
4d543beThanks @HiDeoo! - Improves error message when an invalid configuration or no configuration is provided to the Starlight integration. -
#2645
cf12bebThanks @techfg! - Fixes support for favicon URLs that contain a search query and/or hash -
#2650
38db4ecThanks @raviqqe! - Moves@types/js-yamlpackage to non-dev dependencies -
#2633
5adb720Thanks @HiDeoo! - Fixes a VoiceOver issue with Safari where the content of a<script>element could be read before the sidebar content. -
#2663
34755f9Thanks @astrobot-houston! - Adds a newseti:viteicon for Vite configuration files in the<FileTree>component
-
-
🐞 Patch Changes
-
#2611
6059d96Thanks @HiDeoo! - Fixes a UI string type issue in projects with multiple data content collections. -
#2606
10b15a7Thanks @delucis! - Makes<CardGrid>more resilient to complex child content on smaller viewports -
#2605
ec7ab4fThanks @brianzelip! - ExposesSidebarPersistercomponent in package exports for use in custom overrides -
#2614
9a31980Thanks @HiDeoo! - Fixes an issue with custom pages using the<StarlightPage />component and a custom sidebar missing highlighting for the active page and navigation links. -
#2613
a73780fThanks @delucis! - Fixes support forsidebarfrontmatter options in sidebar entries usingslugor the string shorthand for internal links
-
-
🍿 Minor Changes
-
#2551
154c8e3Thanks @hippotastic! - Updates theastro-expressive-codedependency to the latest version (0.38).The new version allows using
ec.config.mjsto selectively override individual Expressive Code styles and settings provided by Starlight themes and plugins, speeds up Shiki language loading, and adds the config optionexpressiveCode.shiki.injectLangsIntoNestedCodeBlocks. See the Expressive Code release notes for full details. -
#2252
6116db0Thanks @HiDeoo! - Improves build performance for sites with large sidebarsThis 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
a4c8eddThanks @HiDeoo! - Improves the accessibility of asides and tabs by removing some unnecessary HTML landmarks.
🐞 Patch Changes
- #2579
241966bThanks @RafidMuhymin! - Adds social link icon for Nostr
-
-
🐞 Patch Changes
-
#2546
bf42300Thanks @HiDeoo! - Fixes an issue where i18n content collection related errors, e.g. malformed JSON or YAML, would not be reported. -
#2548
07673c8Thanks @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
91e1dd7Thanks @HiDeoo! - Fixes a Firefox Markdown content rendering issue for text sentences separated by a line break. -
#2524
1b46783Thanks @jsparkdev! - Fixes a broken link to Astro’s Docs in an error message
-
-
🐞 Patch Changes
-
#2444
d585b3eThanks @HiDeoo! - Fixes a UI string translation issue for languages with a region subtag. -
#2518
0f69db8Thanks @morinokami! - Updates Japanese UI translations -
#2507
bd6ced5Thanks @HiDeoo! - Fixes a table of contents highlighting issue after resizing the window. -
#2444
d585b3eThanks @HiDeoo! - Refactors various components to use the new built-in localization system to access translated UI strings.
-
-
🐞 Patch Changes
-
#2408
0b4823dThanks @HiDeoo! - Fixes a link formatting issue when using the Astrobuild.formatoption set tofilewith abase. -
#2380
7b451cfThanks @delucis! - Loosen Starlight’s i18n schema to pass through unknown keys -
#2388
6bba3d8Thanks @HiDeoo! - Fixes a potential type-checking issue in Starlight projects. -
#2443
a0f40b3Thanks @kevinzunigacuellar! - Fixes CSS issue where bottom padding is not applied in the search dialog.
-
-
🍿 Minor Changes
-
#1923
5269aadThanks @HiDeoo! - Overhauls the built-in localization system which is now powered by thei18nextlibrary 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.labelsprops 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 newAstro.locals.t()helper instead.---import type { Props } from '@astrojs/starlight/props';// The `search.label` UI label for this page’s language:const searchLabel = Astro.locals.t('search.label');--- -
#2285
7286220Thanks @HiDeoo! - Adds support for translating sidebar badges. -
#1923
5269aadThanks @HiDeoo! - ⚠️ BREAKING CHANGE: The minimum supported version of Astro is now 4.14.0Please update Astro and Starlight together:
Terminal window npx @astrojs/upgrade
🐞 Patch Changes
-
-
🍿 Minor Changes
-
#1255
6f3202bThanks @Fryuni! - Adds support for server-rendered Starlight pages.When building a project with
hybridorserveroutput mode, a newprerenderoption on Starlight config can be set tofalseto make all Starlight pages be rendered on-demand:export default defineConfig({output: 'server',integrations: [starlight({prerender: false,}),],});
🐞 Patch Changes
-
#2242
756e85eThanks @delucis! - Refactors the logic for persisting and restoring sidebar state across navigations for better performance on slow or busy devices -
#1255
6f3202bThanks @Fryuni! - Improves performance of computing the last updated times from Git history.Instead of executing
gitfor each docs page, it is now executed twice regardless of the number of pages. -
#1255
6f3202bThanks @Fryuni! - Fixes last updated times on projects with customsrcDir
-
-
🐞 Patch Changes
-
#2281
5062d30Thanks @HiDeoo! - Fixes a potential text rendering issue that could include extra whitespaces for text containing colons. -
#2279
62d59e2Thanks @HiDeoo! - Fixes an issue with frontmatter schemas containing collection references used with the<StarlightPage />component and an Astro version greater than4.14.0.
-
-
🐞 Patch Changes
-
#2273
746e0cdThanks @delucis! - Fixes type error when using Starlight with Astro v4.15 -
#2265
25b661eThanks @SeraphicRav! - Adds TikTok social icon -
#2250
c0a6166Thanks @HiDeoo! - Removes internal E2E tests from the package published to the npm registry. -
#2253
72bc76aThanks @HiDeoo! - Fixes an issue preventing to use theclassattribute in hero action link buttons.
-
-
🍿 Minor Changes
-
#1784
68f56a7Thanks @HiDeoo! - Adds<LinkButton>component for visually distinct and emphasized call to action links -
#2150
9368494Thanks @delucis! - Adds state persistence across page navigations to the main site sidebar -
#2087
caa84eaThanks @HiDeoo! - Adds persistence to synced<Tabs>so that a user’s choices are reflected across page navigations. -
#2051
ec3b579Thanks @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
68f56a7Thanks @HiDeoo! - Changes the hero component action button default variant fromminimaltoprimary.⚠️ BREAKING CHANGE: If you want to preserve the previous appearance, hero component action buttons previously declared without a
variantwill need to be updated to include thevariantproperty with the valueminimal.hero:actions:- text: View on GitHublink: https://github.com/astronaut/my-projecticon: externalvariant: minimal -
#2168
e044feeThanks @HiDeoo! - ⚠️ BREAKING CHANGE: Updates the<StarlightPage />componentsidebarprop to accept an array ofSidebarItems like the main Starlightsidebarconfiguration inastro.config.mjs.This change simplifies the definition of sidebar items in the
<StarlightPage />component, allows for shared sidebar configuration between the globalsidebaroption 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 customsidebarconfiguration, you will need to update thesidebarprop to an array ofSidebarItemobjects.For example, the following custom page with a custom
sidebarconfiguration defines a “Resources” group with a “New” badge, a link to the “Showcase” page which is part of thedocscontent collection, and a link to the Starlight website:src/pages/custom-page/example.astro <StarlightPagefrontmatter={{ title: 'My custom page' }}sidebar={[{type: 'group',label: 'Resources',badge: { text: 'New' },items: [{ type: 'link', label: 'Showcase', href: '/showcase/' },{type: 'link',label: 'Starlight',href: 'https://starlight.astro.build/',},],},]}><p>This is a custom page with a custom component.</p></StarlightPage>This configuration will now need to be updated to the following:
src/pages/custom-page/example.astro <StarlightPagefrontmatter={{ title: 'My custom page' }}sidebar={[{label: 'Resources',badge: { text: 'New' },items: ['showcase',{ label: 'Starlight', link: 'https://starlight.astro.build/' },],},]}><p>This is a custom page with a custom component.</p></StarlightPage>See the “Sidebar Navigation” guide to learn more about the available options for customizing the sidebar.
-
-
🐞 Patch Changes
-
#2155
8bed886Thanks @delucis! - Improves page load performance on slower devices -
#2167
9ac7725Thanks @delucis! - Fixes an issue detecting the built-in locale when running Starlight in a web container environment on Firefox -
#2166
4f12049Thanks @delucis! - Updates@astrojs/mdx,@astrojs/sitemap,astro-expressive-code,unified, andvfiledependencies to the latest version
-
-
🐞 Patch Changes
-
#2154
0b381d5Thanks @mktbsh! - Updates<head>logic to deduplicate<link rel="canonical">tags. This means that custom canonicals set via frontmatter now override the default canonical generated by Starlight. -
#2157
6757d97Thanks @astrobot-houston! - Updates file tree icon mapping to correctly map.cjsand.mjsextensions in several contexts -
#2156
904ad47Thanks @delucis! - Fixes builds for projects with a space in their pathname -
#2137
703903bThanks @cevdetardaharan! - Removestwitter:titleandtwitter:descriptionmeta tags from<head>
-
-
🐞 Patch Changes
-
#2126
ada51eeThanks @essential-randomness! - Adds support for markdown formatting in aside titles -
#2135
9bbb969Thanks @oluwatobiss! - Adds Pinterest social icon
-
-
🐞 Patch Changes
-
#2122
359a642Thanks @HiDeoo! - Fixes an i18n configuration issue for multilingual sites when using Astro’si18nconfig withprefixDefaultLocaleset tofalse. -
#2107
61e223bThanks @sanabel-al-firdaws! - Updates Arabic UI translations -
#2105
81f8a2cThanks @delucis! - Fixes an edge case in custom pagination link processingCustom link values for
prev/nextin page frontmatter are now always used as authored. Previously this was not the case in some edge cases such as for the first and final pages in the sidebar. -
#2119
464685aThanks @evadecker! - Improves styling of<hr>,<blockquote>, and<code>within asides
-
-
🍿 Minor Changes
-
#2025
47f32c1Thanks @HiDeoo! - Removes the/search shortcut for accessibility reasons.⚠️ Potentially breaking change: The
search.shortcutLabelUI string has been removed. If you were using this string in your custom UI, you will need to update your code. -
#2064
c5b47cbThanks @SnowDingo! - Improves styling of Markdown tables to work better in different contexts, including against different background colours like when used in asides. -
#2031
2bab648Thanks @delucis! - Makes sidebar entry parsing stricter in Starlight config⚠️ Potentially breaking change: Previously Starlight would accept a sidebar entry that matched one of its expected shapes, even if it included additional properties. For example, including both
linkanditemswas considered valid, withitemsbeing ignored. Now, it is an error to include more than one oflink,items, orautogeneratein a sidebar entry.If you see errors after updating, look for sidebar entries in the Starlight configuration in
astro.config.mjsthat include too many keys and remove the one that was previously ignored. -
#1874
eeba06eThanks @lorenzolewis! - Adds a new syntax for specifying sidebar link items for internal linksYou can now specify an internal page using only its slug, either as a string, or as an object with a
slugproperty:starlight({title: 'Docs with easier sidebars',sidebar: ['getting-started', { slug: 'guides/installation' }],});Starlight will use the linked page’s frontmatter to configure the sidebar link.
🐞 Patch Changes
- #2081
f0181d2Thanks @andrii-bodnar! - Updates the Ukrainian UI translations
-
-
🐞 Patch Changes
-
#2062
5ac0ac6Thanks @evadecker! - Increase theme and language select inline padding -
#2056
87e9ad0Thanks @HiDeoo! - Fixes an issue preventing remark plugins injected by Starlight plugins to handle Markdown text and leaf directives. -
#2063
3ee1a94Thanks @delucis! - TranslatefileTree.directoryandaside.*UI string into Norwegian (Bokmål). -
#2054
dbfd3eeThanks @HiDeoo! - Fixes an issue when using the<StarlightPage>component in a custom page with a user-definedsrcDirconfiguration.
-
-
🐞 Patch Changes
-
#2038
87f3f92Thanks @dragomano! - Updates Russian UI translations -
#2043
53f4cd4Thanks @playmr365! - Updates Czech UI translations -
#2041
8af5a60Thanks @HiDeoo! - Fixes<Steps>numbering bug caused by Chrome v126 CSS counter rewrite
-
-
🐞 Patch Changes
-
#2008
40359c7Thanks @vnepogodin! - Add Slovak language UI translation. -
#2004
0aa2f06Thanks @liruifengv! - Removes an outdated export inpackage.json -
#2007
44ca490Thanks @delucis! - Updates internal dependencies -
#1993
60165b2Thanks @HiDeoo! - Fixes an i18n configuration issue when using a single root locale.
-
-
🐞 Patch Changes
-
#1978
a5ab8cd6Thanks @kylewlacy! - Add new social icon for Zulip -
#1962
2ef19a94Thanks @torn4dom4n! - Updates Vietnamese UI translations -
#1976
5a61f73cThanks @jsparkdev! - Updates Korean UI translations -
#1987
0b8a8439Thanks @HiDeoo! - Fixes issues with the locale text direction detection mechanism in some environments like WebContainers or Bun.
-
-
🍿 Minor Changes
-
#1841
ee0cd38aThanks @HiDeoo! - Adds support forAstro.currentLocaleand Astro’s i18n routing.⚠️ Potentially breaking change: Starlight now configures Astro’s
i18noption for you based on itslocalesconfig.If you are currently using Astro’s
i18noption as well as Starlight’slocalesoption, you will need to remove one of these. In general we recommend using Starlight’slocales, but if you have a more advanced configuration you may choose to keep Astro’si18nconfig instead. -
#1958
081d1a96Thanks @delucis! - Allows users to opt into displaying a “Built with Starlight” link in the site footer -
#1530
dd64836aThanks @kevinzunigacuellar! - Adds a new<Badge>component
-
-
🍿 Minor Changes
-
#1846
2de67039Thanks @delucis! - Updates@astrojs/mdxto v3 and enables MDX optimization by default⚠️ Potentially breaking change: MDX optimization speeds up builds (Starlight’s docs are building ~40% faster for example), but restricts some advanced MDX features. See full details in the MDX optimization documentation.
Most Starlight users should be unaffected, but if you are using MDX files outside of Starlight pages with the
componentsprop, you may see issues. You can disable optimization by adding MDX manually to yourintegrationsarray inastro.config.mjs:import { defineConfig } from 'astro/config';import mdx from '@astrojs/mdx';import starlight from '@astrojs/starlight';// https://astro.build/configexport default defineConfig({integrations: [starlight({title: 'My docs',// ...}),mdx(),],}); -
#1735
1a9ab50dThanks @HiDeoo! - Adds custom styles for<details>and<summary>elements in Markdown content. -
#1846
2de67039Thanks @delucis! - ⚠️ BREAKING CHANGE: The minimum supported version of Astro is now 4.8.6Please update Astro and Starlight together:
Terminal window npx @astrojs/upgrade
-
-
🐞 Patch Changes
-
#1871
03bb126bThanks @delucis! - Adds ablueSkyicon and social link option -
#1873
13f33b81Thanks @ekfuhrmann! - Adds 1 new icon:alpine -
#1857
32cdfaf0Thanks @tarikcoskun! - Updates Turkish UI translations -
#1736
cfa94a34Thanks @julien-deramond! - Prevent list items from overflowing Markdown content
-
-
🐞 Patch Changes
-
#1838
9fe84754Thanks @delucis! - Adds extra information to the errors thrown by the<Steps>component to help locate misformatted code -
#1863
50be60bbThanks @torn4dom4n! - Update Vietnamese translation -
#1837
a33a1223Thanks @delucis! - Adds three new icons:comment,comment-alt,heart -
#1842
c7838636Thanks @delucis! - Moves thehrefused in the site title link to Starlight’s route data object. This makes it possible for overrides to change the title link while reusing Starlight’s default component implemenation. -
#1840
cb85563cThanks @MiahaCybersec! - Adds 1 new icon:hackerone
-
-
🍿 Minor Changes
-
#640
7dc503eaThanks @HiDeoo! - Adds support for syncing multiple sets of tabs on the same page. -
#1620
ca0678caThanks @emjio! - Adds support for translating the site title⚠️ Potentially breaking change: The shape of the
titlefield on Starlight’s internal config object has changed. This used to be a string, but is now an object.If you are relying on
config.title(for example in a custom<SiteTitle>or<Head>component), you will need to update your code. We recommend using the newsiteTitleprop available to component overrides:---import type { Props } from '@astrojs/starlight/props';// The site title for this page’s language:const { siteTitle } = Astro.props;--- -
#1613
61493e55Thanks @HiDeoo! - Adds newdraftfrontmatter option to exclude a page from production builds. -
#640
7dc503eaThanks @HiDeoo! - Updates the defaultline-heightfrom1.8to1.75. This change avoids having a line height with a fractional part which can cause scripts accessing dimensions involving the line height to get an inconsistent rounded value in various browsers.If you want to preserve the previous
line-height, you can add the following custom CSS to your site::root {--sl-line-height: 1.8;} -
#1720
749ddf85Thanks @jacobdalamb! - Updatesastro-expressive-codedependency to the latest minor release (0.35) and exposes a new@astrojs/starlight/expressive-code/hastmodule for users who need to use Expressive Code’s version ofhast.This includes a potentially breaking change if you use custom Expressive Code plugins. See the Expressive Code release notes for full details.
-
#1769
bd5f1cbdThanks @ncjones! - Adds support for accessing frontmatter data as a variable when using Markdoc
🐞 Patch Changes
-
#1788
681a4273Thanks @dragomano! - Adds Russian translations for Expressive Code labels -
#1780
4db6025aThanks @MiahaCybersec! - Adds 1 new icon:signal -
#1785
65009c9cThanks @dreyfus92! - Adds 5 new icons:node,cloudflare,vercel,netlifyanddeno -
#1786
d05d693aThanks @delucis! - Fixes type inference for i18n strings added by extending the default schema -
#1777
6949404bThanks @HiDeoo! - Fixes an issue where TypeScript could fail to serialize the frontmatter schema when configured to emit declaration files -
#1734
4493dcfaThanks @delucis! - Refactors<ThemeSelect>custom element logic to improve performance -
#1731
f08b0dffThanks @techfg! - Fixes responding to system color scheme changes when theme isauto -
#1793
2616f0c7Thanks @Mrahmani71! - Updates the Farsi UI translations
-
-
🐞 Patch Changes
-
#1709
c5cd1811Thanks @HiDeoo! - Fixes a UI strings translation issue for sites configured with a single non-root language different from English. -
#1723
3b29b3abThanks @OliverSpeir! - Fixes accessibility by usingaria-selected="false"for inactive tabs instead of removingaria-selected="true"in the tablist of Starlight’s<Tabs>component -
#1706
f171ac4dThanks @jorenbroekema! - Fixes some minor type errors
-
🐞 Patch Changes
-
#1622
3a074badThanks @SamuelLHuber! - Adds 1 new icon:farcaster -
#1616
a86f9b71Thanks @dragomano! - Updates Russian UI strings -
#1698
67b892fdThanks @liruifengv! - Adds 1 new icon:starlight -
#1687
6fa9ea7eThanks @mingjunlu! - TranslatesfileTree.directoryUI string into Traditional Chinese.
-
-
🐞 Patch Changes
-
#1614
78fc9042Thanks @kpodurgiel! - Adds Polish UI translations -
#1596
13ed30cdThanks @HiDeoo! - Adds support for toggling the built-in search modal using theCtrl+kkeyboard shortcut. -
#1608
4096e1b7Thanks @HiDeoo! - Removes nested CSS from the<FileTree>component to prevent a potential warning when using Tailwind CSS. -
#1626
67459cb4Thanks @hippotastic! - Fixes a bundling issue that caused imports from@astrojs/starlight/componentsto fail when using the config settingexpressiveCode: false.
-
🐞 Patch Changes
-
#1584
8851d5cdThanks @HiDeoo! - Adds 2 new icons:appleandlinux. -
#1577
0ba77890Thanks @morinokami! - TranslatesfileTree.directoryUI string into Japanese. -
#1593
fa7ed245Thanks @liruifengv! - TranslatesfileTree.directoryUI string into simplified Chinese. -
#1585
bd4e278fThanks @HiDeoo! - TranslatesfileTree.directoryUI string into French. -
#1587
c5794260Thanks @Eveeifyeve! - Adds 1 new icon:homebrew.
-
-
🍿 Minor Changes
-
#1568
5f99a71dThanks @HiDeoo! - Adds support for optionally setting an icon on a<TabItem>component to make it easier to visually distinguish between tabs. -
#1308
9a918a5bThanks @HiDeoo! - Adds<FileTree>component to display the structure of a directory. -
#1308
9a918a5bThanks @HiDeoo! - Adds 144 new file-type icons from the Seti UI icon set, available with theseti:prefix, e.g.seti:javascript. -
#1564
d880065eThanks @delucis! - Adds a<Steps>component for styling more complex guided tasks. -
#1308
9a918a5bThanks @HiDeoo! - Adds 5 new icons:astro,biome,bun,mdx, andpnpm.
-
-
🐞 Patch Changes
- #1553
8e091147Thanks @hippotastic! - Updates Expressive Code to v0.33.4 to fix potential race condition bug in Shiki.
- #1553
-
🍿 Minor Changes
-
#1541
1043052fThanks @hippotastic! - Updatesastro-expressive-codedependency to the latest minor release (0.33).This unlocks support for word wrap and line numbers, as well as updating the syntax highlighter to the latest Shiki release, which includes new and updated language grammars.
See the Expressive Code release notes for more information including details of potentially breaking changes.
🐞 Patch Changes
-
-
🐞 Patch Changes
-
#1527
163bc84Thanks @HiDeoo! - Exports theStarlightPagePropsTypeScript type representing the props expected by the<StarlightPage />component. -
#1504
fc83a05Thanks @mingjunlu! - Adds Traditional Chinese UI translations -
#1534
aada680Thanks @delucis! - Improves DX of thesidebarprop used by the new<StarlightPage>component.
-
-
🍿 Minor Changes
-
#1485
2cb3578Thanks @timokoessler! - Add support for setting html attributes of hero action links -
#1175
dd11b95Thanks @HiDeoo! - Adds a new<StarlightPage>component to use the Starlight layout in custom pages.To learn more about this new feature, check out the new “Using Starlight’s design in custom pages” guide.
-
#1499
97bf523Thanks @delucis! - Adds a new<Aside>componentThe new component is in addition to the existing custom Markdown syntax.
-
-
🍿 Minor Changes
-
#1454
1d9ef56Thanks @Fryuni! - Makes Starlight compatible with on-demand server rendering (sometimes referred to as server-side rendering or SSR).Starlight pages are always prerendered, even when using
output: 'server'. -
#1454
1d9ef56Thanks @Fryuni! - Enables Astro’sexperimental.globalRoutePriorityoption and bumps the minimum required Astro version.⚠️ BREAKING CHANGE The minimum supported Astro version is now 4.2.7. Upgrade Astro and Starlight together:
Terminal window npx @astrojs/upgrade
-
-
🐞 Patch Changes
-
#1461
2e17880Thanks @liruifengv! - Improves the table of contents title translation in Simplified Chinese -
#1462
4741cccThanks @delucis! - Fixes overflow of very long site titles on narrow viewports -
#1459
9a8e0ecThanks @delucis! - Fixes a bug where table of contents highlighting could break given very specific combinations of content and viewport size -
#1458
8c88642Thanks @delucis! - Silences i18n content collection warnings for projects without custom translations.
-
-
🐞 Patch Changes
-
#1437
655aed4Thanks @hippotastic! - Adds Starlight-specific types todefineEcConfigfunction and exportsStarlightExpressiveCodeOptions.This provides Starlight types and IntelliSense support for your Expressive Code configuration options inside an
ec.config.mjsfile. See the Expressive Code documentation for more information. -
#1420
275f87fThanks @abdelhalimjean! - Fix rarefont-familyissue if users have a font installed with a name of"" -
#1365
a0af7ccThanks @kevinzunigacuellar! - Correctly format Pagefind search result links whentrailingSlash: 'never'is used
-
-
🍿 Minor Changes
-
#1389
21b3620Thanks @connor-baer! - Adds newdisable404Routeconfig option to disable injection of Astro’s default 404 route -
#1395
ce05dfbThanks @hippotastic! - Adds a new<Code>component to render dynamic code strings with Expressive Code
-
-
🍿 Minor Changes
-
#1383
490c6efThanks @delucis! - Refactors Starlight’s internal virtual module system for components to avoid circular referencesThis is a change to an internal API. If you were importing the internal
virtual:starlight/componentsmodule, this no longer exists. Update your imports to use the individual virtual modules now available for each component, for examplevirtual:starlight/components/EditLink. -
#1151
134292dThanks @kevinzunigacuellar! - Fixes sidebar auto-generation issue when a file and a directory, located at the same level, have identical names.For example,
src/content/docs/guides.mdandsrc/content/docs/guides/example.mdwill now both be included andsrc/content/docs/guides.mdis treated in the same way asrc/content/docs/guides/index.mdfile would be. -
#1386
0163634Thanks @delucis! - Tightensline-heighton<LinkCard>titles to fix regression from original designIf you want to preserve the previous
line-height, you can add the following custom CSS to your site:.sl-link-card a {line-height: 1.6;} -
#1376
8398432Thanks @delucis! - Tweaks vertical spacing in Markdown content styles.This is a subtle change to Starlight’s default content styling that should improve most sites:
- Default vertical spacing between content items is reduced from
1.5remto1rem. - Spacing before headings is now relative to font size, meaning higher-level headings have slightly more spacing and lower-level headings slightly less.
The overall impact is to tighten up content that belongs together and improve the visual hierarchy of headings to break up sections.
Although this is a subtle change, we recommend visually inspecting your site in case this impacts layout of any custom CSS or components.
If you want to preserve the previous spacing, you can add the following custom CSS to your site:
/* Restore vertical spacing to match Starlight v0.15 and below. */.sl-markdown-content:not(a, strong, em, del, span, input, code)+ :not(a, strong, em, del, span, input, code, :where(.not-content *)) {margin-top: 1.5rem;}.sl-markdown-content:not(h1, h2, h3, h4, h5, h6)+ :is(h1, h2, h3, h4, h5, h6):not(:where(.not-content *)) {margin-top: 2.5rem;} - Default vertical spacing between content items is reduced from
-
#1372
773880dThanks @HiDeoo! - Updates the table of contents highlighting styles to prevent UI shifts when scrolling through a page.If you want to preserve the previous, buggy styling, you can add the following custom CSS to your site:
starlight-toc a[aria-current='true'],starlight-toc a[aria-current='true']:hover,starlight-toc a[aria-current='true']:focus {font-weight: 600;color: var(--sl-color-text-invert);background-color: var(--sl-color-text-accent);}
-
-
🐞 Patch Changes
-
#1303
3eefd21Thanks @lilnasy! - chore: fix type errors in Starlight internals -
#1351
932c022Thanks @roberto-butti! - Adds Italian translation forsearch.devWarningUI -
#1298
c7e995cThanks @kevinzunigacuellar! - Fixes incorrect sorting behavior for some autogenerated sidebars -
#1347
8994d00Thanks @kevinzunigacuellar! - RefactorgetLastUpdatedto usenode:child_processinstead ofexeca. -
#1353
90fe8daThanks @delucis! - Fixes sidebar scrollbar hiding behind navbar
-
-
🐞 Patch Changes
-
#1273
ae53155Thanks @natemoo-re! - Updates<SocialIcon />styling for improved accessibility. Specifically, the component now meets the Target Size (Minimum) success criteria defined by Web Content Accessibility Guidelines (WCAG) 2.2. -
#1289
9bd343fThanks @HiDeoo! - Adds French translations for Expressive Code UI -
#1280
6b1693dThanks @kevinzunigacuellar! - Adds Spanish translations for Expressive Code UI -
#1276
667f23dThanks @hippotastic! - Updatesastro-expressive-codedependency to the latest version -
#1266
c9edf30Thanks @alex-way! - Removes redundant subprocess calls in git last-updated time utility to improve performance -
#1278
e88abb0Thanks @HiDeoo! - Exports theStarlightUserConfigTypeScript type representing the user’s Starlight configuration received by plugins.
-
-
🍿 Minor Changes
-
#1238
02a808eThanks @delucis! - Add support for Astro v4, drop support for Astro v3⚠️ BREAKING CHANGE Astro v3 is no longer supported. Make sure you update Astro and any other integrations at the same time as updating Starlight.
Use the new
@astrojs/upgradecommand to upgrade Astro and Starlight together:Terminal window npx @astrojs/upgrade -
#1242
d8fc9e1Thanks @delucis! - Enables link prefetching on hover by defaultAstro v4’s prefetch support is now enabled by default. If
prefetchis not set inastro.config.mjs, Starlight will useprefetch: { prefetchAll: true, defaultStrategy: 'hover' }by default.If you want to preserve previous behaviour, disable link prefetching in
astro.config.mjs:import { defineConfig } from 'astro/config';import starlight from '@astrojs/starlight';export default defineConfig({// Disable link prefetching:prefetch: false,integrations: [starlight({// ...}),],});
🐞 Patch Changes
-
-
🍿 Minor Changes
-
#1144
7c0b8cbThanks @delucis! - Adds a configuration option to disable site indexing with Pagefind and the default search UI -
#942
efd7fdcThanks @HiDeoo! - Adds plugin APISee the plugins reference to learn more about creating plugins for Starlight using this new API.
-
#1135
e5a863aThanks @delucis! - Exposes localized UI strings in route dataComponent overrides can now access a
labelsobject in their props which includes all the localized UI strings for the current page. -
#1162
00d101bThanks @delucis! - Adds support for extending Starlight’s content collection schemas
-
-
🍿 Minor Changes
-
#1023
a3b80f7Thanks @kevinzunigacuellar! - Respect thetrailingSlashandbuild.formatAstro options when creating Starlight navigation links.⚠️ Potentially breaking change: This change will cause small changes in link formatting for most sites. These are unlikely to break anything, but if you care about link formatting, you may want to change some Astro settings.
If you want to preserve Starlight’s previous behavior, set
trailingSlash: 'always'in yourastro.config.mjs:import { defineConfig } from 'astro/config';import starlight from '@astrojs/starlight';export default defineConfig({trailingSlash: 'always',integrations: [starlight({// ...}),],}); -
#742
c6a4bcbThanks @hippotastic! - Adds Expressive Code as Starlight’s default code block renderer⚠️ Potentially breaking change: This addition changes how Markdown code blocks are rendered. By default, Starlight will now use Expressive Code. If you were already customizing how code blocks are rendered and don’t want to use the features provided by Expressive Code, you can preserve the previous behavior by setting the new config option
expressiveCodetofalse.If you had previously added Expressive Code manually to your Starlight project, you can now remove the manual set-up in
astro.config.mjs:- Move your configuration to Starlight’s new
expressiveCodeoption. - Remove the
astro-expressive-codeintegration.
For example:
import starlight from '@astrojs/starlight';import { defineConfig } from 'astro/config';import expressiveCode from 'astro-expressive-code';export default defineConfig({integrations: [expressiveCode({themes: ['rose-pine'],}),starlight({title: 'My docs',expressiveCode: {themes: ['rose-pine'],},}),],});Note that the built-in Starlight version of Expressive Code sets some opinionated defaults that are different from the
astro-expressive-codedefaults. You may need to set somestyleOverridesif you wish to keep styles exactly the same. - Move your configuration to Starlight’s new
-
#517
5b549cbThanks @liruifengv! - Add i18n support for default aside labels
🐞 Patch Changes
-
#1088
4fe5537Thanks @Lootjs! - i18n(ru): added Russian aside labels translation -
#1083
e03a653Thanks @at-the-vr! - i18n(hi): Add Hindi language support -
#1075
2f2adf2Thanks @russbiggs! - Add Slack social link icon -
#1065
2d72ed6Thanks @HiDeoo! - Ignore search keyboard shortcuts for elements with contents that are editable -
#1081
f27f781Thanks @farisphp! - i18n(id): Add Indonesian aside labels translation -
#1082
ce27486Thanks @bogdaaamn! - i18n(ro): Add Romanian UI translations
-
-
🐞 Patch Changes
-
#1069
b86f360Thanks @Genteure! - Fix sidebar highlighting and navigation buttons for pages with path containing non-ASCII characters -
#1025
0d1e75eThanks @HiDeoo! - Internal: fix import issue in translation string loading mechanism -
#1044
a5a9754Thanks @HiDeoo! - Fix last updated dates for pages displaying fallback content -
#1049
c27495dThanks @HiDeoo! - Expose Markdown content styles in@astrojs/starlight/style/markdown.css
-
-
🍿 Minor Changes
-
#995
5bf4457Thanks @kevinzunigacuellar! - Adds support for adding sidebar badges to group headings -
#988
977fe13Thanks @magicDGS! - Include social icon links in mobile menu -
#280
72cca2dThanks @cbontems! - Support light & dark variants of the hero image.⚠️ Potentially breaking change: The
hero.imageschema is now slightly stricter than previously.The
hero.image.htmlproperty can no longer be used alongside thehero.image.altorhero.image.fileproperties. Previously,htmlwas ignored when used withfileandaltwas ignored when used withhtml. Now, those combinations will throw errors. If you encounter errors, remove theimage.heroproperty that is not in use.
🐞 Patch Changes
-
-
🐞 Patch Changes
-
#944
7a6446eThanks @HiDeoo! - Fix issue with sidebar autogenerated groups configured with a directory containing leading or trailing slash -
#985
92b3b57Thanks @delucis! - Fix edit URLs for pages displaying fallback content -
#986
0470734Thanks @dreyfus92! - Prevent overscrolling on mobile table of contents by setting ‘overscroll-behavior: contain’. -
#924
39d6302Thanks @kevinzunigacuellar! - Remove extra margin from markdown lists that uses inline code -
#814
1e517d9Thanks @julien-deramond! - Prevent text from overflowing pagination items
-
-
🐞 Patch Changes
-
#892
2b30321Thanks @delucis! - Add Patreon social link icon -
#852
344c92eThanks @Lootjs! - Improve Russian language support -
#891
395920cThanks @Frikadellios! - Add Ukrainian language support -
#890
63ea8e8Thanks @delucis! - Updateexecadependency to v8 -
#859
eaa7a90Thanks @oggnimodd! - Improve Indonesian language support
-
-
🍿 Minor Changes
-
#774
903a579Thanks @HiDeoo! - Support adding HTML attributes to sidebar links from config and frontmatter -
#796
372ec96Thanks @HiDeoo! - Add the@astrojs/sitemapand@astrojs/mdxintegrations only if they are not detected in the Astro configuration.⚠️ BREAKING CHANGE The minimum supported version of Astro is now v3.2.0. Make sure you update Astro at the same time as updating Starlight:
Terminal window npm install astro@latest -
#447
b45719bThanks @andremralves! - AddtitleDelimiterconfiguration option and include site title in page<title>tags⚠️ BREAKING CHANGE — Previously, every page’s
<title>only included its individual frontmatter title. Now,<title>tags include the page title, a delimiter character (|by default), and the site title. For example, in the Startlight docs,<title>Configuration Reference</title>is now<title>Configuration Reference | Starlight</title>.If you have a page where you need to override this new behaviour, set a custom title using the
headfrontmatter property:---title: My Pagehead:- tag: titlecontent: Custom Title--- -
#709
140e729Thanks @delucis! - Add support for overriding Starlight’s built-in components⚠️ BREAKING CHANGE — The page footer is now included on pages with
template: splashin their frontmatter. Previously, this was not the case. If you are usingtemplate: splashand want to continue to hide footer elements, disable them in your frontmatter:---title: Landing pagetemplate: splash# Disable unwanted footer elements as needededitUrl: falselastUpdated: falseprev: falsenext: false---⚠️ BREAKING CHANGE — This change involved refactoring the structure of some of Starlight’s built-in components slightly. If you were previously overriding these using other techniques, you may need to adjust your code.
🐞 Patch Changes
-
#810
dbe977bThanks @hasham-qaiser! - Use<span>instead of<h2>in sidebar group headings -
#807
7c73dd1Thanks @torn4dom4n! - Add Vietnamese translations for Starlight UI -
#756
f55a8f0Thanks @julien-deramond! - Prevent text from overflowing in several cases
-
-
🐞 Patch Changes
-
🐞 Patch Changes
-
#783
f94727eThanks @kevinzunigacuellar! - Fix GitHub edit link to include src path from project config -
#781
a293ef9Thanks @dreyfus92! - Removed role from Banner component to avoid duplication in header. -
#745
006d606Thanks @TheOtterlord! - Prevent Starlight crashing when the content folder doesn’t exist, or is empty -
#775
2ef3036Thanks @delucis! - Fix content collection schema compatibility with Astro 3.1 and higher -
#773
423d575Thanks @tlandmangh! - Fix Dutch UI translation for “Previous page” links
-
-
🐞 Patch Changes
-
🍿 Minor Changes
🐞 Patch Changes
-
🐞 Patch Changes
-
#647
ea57726Thanks @bgmort! - Fix translated 404 pages not being excluded from search results -
#667
9828f73Thanks @delucis! - Break inline<code>across lines to avoid overflow -
#642
e623d92Thanks @fk! - Don’t hard-code nav height in table of contents highlighting script -
#676
6419006Thanks @vedmalex! - Upgrade and pin Pagefind to latest beta release. -
#647
ea57726Thanks @bgmort! - Add frontmatter option to exclude a page from Pagefind search results
-
-
🍿 Minor Changes
-
#626
5dd22b8Thanks @delucis! - Throw an error for duplicate MDX or sitemap integrations -
#615
7b75b3eThanks @delucis! - Bump minimum required Astro version to 3.0⚠️ BREAKING CHANGE Astro v2 is no longer supported. Make sure you update Astro and any other integrations at the same time as updating Starlight.
-
-
🐞 Patch Changes
- #612
1b367e3Thanks @KubaJastrz! - Avoid applying hovered<select>text color to its<options>
- #612
-
🍿 Minor Changes
-
#529
c2d0e7fThanks @delucis! - For improved compatibility with Tailwind, some Starlight built-in class names are now prefixed with"sl-".While not likely, if you were relying on one of these internal class names in your own components or custom CSS, you will need to update to use the prefixed version.
- Before:
flex,md:flex,lg:flex,block,md:block,lg:block,hidden,md:hidden,lg:hidden. - After:
sl-flex,md:sl-flex,lg:sl-flex,sl-block,md:sl-block,lg:sl-block,sl-hidden,md:sl-hidden,lg:sl-hidden.
- Before:
-
#593
5b8af95Thanks @delucis! - Add announcement banner feature -
#516
70a32a1Thanks @kevinzunigacuellar! - Support adding badges to sidebar links from config file and frontmatter
🐞 Patch Changes
-
-
🐞 Patch Changes
-
#525
87caf21Thanks @delucis! - Improve inline code and code block support in RTL languages -
#537
56c19bcThanks @carlgleisner! - Add Swedish UI translations. -
#528
f5e5503Thanks @jsparkdev! - add Korean language support
-
-
🐞 Patch Changes
-
#506
5e3133cThanks @HiDeoo! - Improve table of content current item highlight behavior -
#499
fcff49eThanks @D3vil0p3r! - Add icons for Instagram -
#502
3c87a16Thanks @Mrahmani71! - Add Farsi UI translations -
#496
cd28392Thanks @lorenzolewis! - FixlastUpdateddate position to be consistent -
#402
d8669b8Thanks @chopfitzroy! - Fix content sometimes appearing above the mobile table of contents.
-
-
🐞 Patch Changes
-
🍿 Minor Changes
-
#441
0119a49Thanks @lorenzolewis! - Add support for hiding entries from an autogenerated sidebar:---title: About this projectsidebar:hidden: true--- -
#470
d076aecThanks @delucis! - Drop support for the--sl-hue-accentCSS custom property.⚠️ BREAKING CHANGE — In previous Starlight versions you could control the accent color by setting the
--sl-hue-accentcustom property. This could result in inaccessible color contrast and unpredictable results.You must now set accent colors directly. If you relied on setting
--sl-hue-accent, migrate by setting light and dark mode colors in your custom CSS::root {--sl-hue-accent: 234;--sl-color-accent-low: hsl(var(--sl-hue-accent), 54%, 20%);--sl-color-accent: hsl(var(--sl-hue-accent), 100%, 60%);--sl-color-accent-high: hsl(var(--sl-hue-accent), 100%, 87%);}:root[data-theme='light'] {--sl-color-accent-high: hsl(var(--sl-hue-accent), 80%, 30%);--sl-color-accent: hsl(var(--sl-hue-accent), 90%, 60%);--sl-color-accent-low: hsl(var(--sl-hue-accent), 88%, 90%);}The new color theme editor might help if you’d prefer to set a new color scheme.
-
#397
73eb5e6Thanks @lorenzolewis! - AddLinkCardcomponent
🐞 Patch Changes
-
#460
2e0fb90Thanks @HiDeoo! - Fix current page highlight in sidebar for URLs with no trailing slash -
#467
461a5d5Thanks @delucis! - Fix type error for downstreamtscusers -
#475
06a205eThanks @Yan-Thomas! - Locales whose language tag includes a regional subtag now use built-in UI translations for their base language. For example, a locale with a language ofpt-BRwill use ourptUI translations. -
#473
6a7692aThanks @HiDeoo! - Fix issue with nested<Tabs>components
-
-
🍿 Minor Changes
-
#424
4485d90Thanks @delucis! - Add support for customising autogenerated sidebar link labels from page frontmatter, overriding the page title:---title: About this projectsidebar:label: About--- -
#359
e733311Thanks @IDurward! - Add support for defining the order of auto-generated link groups in the sidebar using a frontmatter value:---title: Page to display firstsidebar:order: 1---
🐞 Patch Changes
-
#413
5a9d8f1Thanks @delucis! - Fix site title overflow bug for longer titles on narrow screens -
#381
6e62909Thanks @lorenzolewis! - Preserve order ofsocialconfig in navbar -
#419
38ff53cThanks @lorenzolewis! - Improve styling of sidebar entries that wrap onto multiple lines -
#418
c7b2a4eThanks @delucis! - Settab-size: 2on content code blocks to override default browser value of8 -
#399
31b8a5aThanks @HiDeoo! - Add new globalfaviconoption defaulting to'/favicon.svg'to set the path of the default favicon for your website. Additional icons can be specified using theheadoption. -
#414
e951671Thanks @delucis! - Add GitLab to social link icons
-
-
🐞 Patch Changes
-
#383
0ebc47eThanks @delucis! - Fix edge case where index files in an index directory would end up with the wrong slug -
#373
308b3aaThanks @lorenzolewis! - Fix visual overflow for wide logos -
#385
fb35397Thanks @lorenzolewis! - Fix nested elements in markdown content -
#386
e6f6f30Thanks @huijing! - Prevent search keyboard shortcuts from triggering when input elements are focused
-
-
🐞 Patch Changes
- #360
8415df6Thanks @HiDeoo! - Fix build warnings when using the TypeScriptverbatimModuleSyntaxcompiler option
- #360
-
🐞 Patch Changes
-
#352
a2e23beThanks @TheOtterlord! - Fix page scrolling when the window resizes, while the mobile nav is open -
#353
65b2b75Thanks @liruifengv! - Add Simplified Chinese language support
-
-
🐞 Patch Changes
-
#336
2b3302bThanks @delucis! - Add support for LinkedIn, Threads, and Twitch social icon links -
#335
757c65fThanks @delucis! - Fix relative path resolution on Windows -
#332
0600c1aThanks @sasoria! - Add Norwegian UI translations -
#328
e478848Thanks @astridx! - Add missing accessible labels for Codeberg and YouTube social links
-
-
🍿 Minor Changes
-
#313
dc42569Thanks @delucis! - Add anot-contentCSS class that allows users to opt out of Starlight’s default content styling -
#297
fb15a9bThanks @HiDeoo! - Improve<Tabs>component keyboard interactions -
#303
69b7d4cThanks @HiDeoo! - Add new globalpaginationoption defaulting totrueto define whether or not the previous and next page links are shown in the footer. A page can override this setting or the link text and/or URL using the newprevandnextfrontmatter fields.
🐞 Patch Changes
-
-
🍿 Minor Changes
-
#259
8102389Thanks @HiDeoo! - Add support for collapsed sidebar groups -
#256
048e948Thanks @HiDeoo! - Add new globallastUpdatedoption defaulting tofalseto define whether or not the last updated date is shown in the footer. A page can override this setting or the generated date using the newlastUpdatedfrontmatter field.⚠️ Breaking change. Starlight will no longer show this date by default. To keep the previous behavior, you must explicitly set
lastUpdatedtotruein your configuration.starlight({lastUpdated: true,}),
🐞 Patch Changes
-
#264
ed1e46bThanks @astridx! - Add new icon for displaying codeberg.org in social links. -
#260
01b65b1Thanks @ElianCodes! - Add Dutch UI translations -
#269
fdc18b5Thanks @baspinarenes! - Add Turkish UI translations -
#270
1d3e705Thanks @cbontems! - Improve French UI translations -
#272
6b23ebcThanks @cbontems! - Add YouTube social link support -
#273
d4f5134Thanks @Waxer59! - Fix typo in Spanish UI translations
-
-
🍿 Minor Changes
-
#237
4279d75Thanks @HiDeoo! - Use path instead of slugified path for auto-generated sidebar item configuration⚠️ Potentially breaking change. If your docs directory names don’t match their URLs, for example they contain whitespace like
docs/my docs/, and you were referencing these in anautogeneratesidebar group asmy-docs, update your config to reference these with the directory name instead of the slugified version:autogenerate: {directory: 'my-docs',directory: 'my docs',} -
#226
1aa2187Thanks @delucis! - Add support for custom 404 pages.
🐞 Patch Changes
-
#234
91309aeThanks @morinokami! - Add Japanese translation forsearch.devWarning -
#227
fbdecfaThanks @Yan-Thomas! - Add missing i18n support to the Search component’s dev warning. -
#244
f1bcbebThanks @Waxer59! - Add Spanish translation forsearch.devWarning
-
-
🍿 Minor Changes
-
#171
198c3f0Thanks @delucis! - Add Starlight generator tag to HTML output -
#217
490fd98Thanks @delucis! - Updated sidebar styles. Sidebars now support top-level links and groups are styled with a subtle border and indentation to improve comprehension of nesting. -
#178
d046c55Thanks @delucis! - Add support for translating the Pagefind search modal -
#210
cb5b121Thanks @delucis! - Change page title ID to_topfor cleaner hash URLs⚠️ Potentially breaking change if you were linking manually to
#starlight__overviewanywhere. If you were, update these links to use#_topinstead.
🐞 Patch Changes
-
-
🐞 Patch Changes
-
#190
a3809e4Thanks @gabrielemercolino! - Added Italian language support -
#193
c9ca4ebThanks @BryceRussell! - Fix bottom padding for sidebar on larger screen sizes
-
-
🐞 Patch Changes
-
#174
6ab31b4Thanks @rviscomi! - SplitwithBaseURL helper to fix use with files. -
#168
cb18eefThanks @BryceRussell! - Fix bottom padding on left sidebar -
#167
990ec53Thanks @BryceRussell! - AddbundlePathoption to Pagefind configuration -
4f666baThanks @delucis! - Fix focus outline positioning in tabs
-
-
🐞 Patch Changes
-
#155 Thanks @thomasbnt! - Add French language support
-
#158
92d82f5Thanks @kevinzunigacuellar! - Fix word wrapping in search modal on narrow screens
-
-
🐞 Patch Changes
-
fab453cThanks @delucis! - Design tweak: larger sidebar text with more spacing -
#134
5f4acdfThanks @Yan-Thomas! - Add Portuguese language support -
8805fbfThanks @delucis! - Add box-shadow to prev/next page links as per designs -
81ef58eThanks @delucis! - Design tweak: slightly less horizontal padding in header component on narrower viewports -
8c103b3Thanks @delucis! - Design tweak: pad bottom of page content slightly -
#129
bbcb277Thanks @delucis! - Fix bug setting writing direction from a single root locale
-
-
🐞 Patch Changes
-
ded79afThanks @delucis! - Add missing skip link to 404 page -
#99
d162b2fThanks @delucis! - Fix “next page” arrow showing on pages not in sidebar -
#99
d162b2fThanks @delucis! - Add support for a “splash” layout -
#99
d162b2fThanks @delucis! - Support hiding right sidebar table of contents -
#99
d162b2fThanks @delucis! - Move edit page link to page footer so it is accessible on mobile
-
-
🐞 Patch Changes
-
8688778Thanks @delucis! - Fix small CSS compatibility issue -
#93
c6d7960Thanks @delucis! - Fix default locale routing bug when not using root locale -
d8a171bThanks @delucis! - Fix autogenerated sidebar bug with index routes in subdirectories -
d8b9f32Thanks @delucis! - Fix false positive in sidebar autogeneration logic -
#92
02821d2Thanks @delucis! - Update Pagefind to latest v1 alpha -
51fe914Thanks @delucis! - Guarantee route and autogenerated sidebar sort order -
116c4f5Thanks @delucis! - Fix minor dev layout bug in Search modal for RTL languages
-
-
🐞 Patch Changes
- #85
c86c1d6Thanks @BryceRussell! - Improve outside click detection on the search modal
- #85
-
🐞 Patch Changes
-
#78
d3ee6fcThanks @delucis! - Add support for customising and translating Starlight’s UI.Users can provide translations in JSON files in
src/content/i18n/which is a data collection. For example, asrc/content/i18n/de.jsonmight translate the search UI:{"search.label": "Suchen","search.shortcutLabel": "(Drücke / zum Suchen)"}This change also allows Starlight to provide built-in support for more languages than just English and adds German & Spanish support.
-
#76
5e82073Thanks @lloydjatkinson! - Scale down code block font size to match Figma design -
#78
d3ee6fcThanks @delucis! - Require a minimum Astro version of 2.5.0
-
-
🐞 Patch Changes
-
#62
a91191eThanks @delucis! - Makebasesupport consistent, including whentrailingSlash: 'never'is set. -
#61
608f34cThanks @liruifengv! - Fix toc headingsObserver rootMargin -
#66
9ca67d8Thanks @Yan-Thomas! - Make site title width fit the content -
#64
4460e55Thanks @delucis! - Fix table of contents intersection observer for all possible viewport sizes. -
#67
38c2c1fThanks @TheOtterlord! - Fix background color on select component -
#57
5b6cccbThanks @BryceRussell! - Update site title link to include locale
-
-
🐞 Patch Changes
-
#55
8597b9cThanks @delucis! - Fix routing logic to handleindex.mdslug differences between docs collection root and nested directories. -
#54
db728d6Thanks @TheOtterlord! - Add padding to scroll preventing headings being obscured by nav -
#51
3adbdbbThanks @delucis! - Support displaying a custom logo in the nav bar. -
#51
3adbdbbThanks @delucis! - All Starlight projects now use Astro’s experimental optimized asset support.
-
-
🐞 Patch Changes
-
#47
e96d9a7Thanks @delucis! - Fix CSS ordering issue caused by imports in 404 route. -
#47
e96d9a7Thanks @delucis! - Highlight current page section in table of contents. -
05f8fd4Thanks @delucis! - Includeinitial-scale=1in viewport meta tag. -
#47
e96d9a7Thanks @delucis! - Fix usage ofaria-currentin navigation sidebar to usepagevalue. -
#48
a49485dThanks @delucis! - Improve right sidebar layout.
-