98 KiB
@astrojs/starlight
0.22.1
Patch Changes
1c0fc384Thanks @HiDeoo! - Fixes an issue where thesiteTitleproperty would not be set when using the<StarlightPage />component.
0.22.0
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
0.21.5
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
0.21.4
Patch Changes
-
#1703
b26238f2Thanks @HiDeoo! - Fixes aside custom titles rendering for nested asides. -
#1708
a72cb966Thanks @HiDeoo! - Fixes translation issues with Expressive Code when using a default language other than English
0.21.3
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.
0.21.2
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.
0.21.1
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.
0.21.0
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.
0.20.1
Patch Changes
- #1553
8e091147Thanks @hippotastic! - Updates Expressive Code to v0.33.4 to fix potential race condition bug in Shiki.
0.20.0
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
-
#1542
b3b7a606Thanks @delucis! - Improves error messages shown by Starlight for configuration errors. -
#1544
65dc6586Thanks @torn4dom4n! - Update Vietnamese UI translations
0.19.1
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.
0.19.0
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.
0.18.1
Patch Changes
-
#1487
6a72bdaThanks @NavyStack! - Improves Korean UI translations -
#1489
b0d36deThanks @HiDeoo! - Fixes a potential text rendering issue with text containing colons.
0.18.0
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:
npx @astrojs/upgrade
0.17.4
Patch Changes
-
#1473
29da505Thanks @delucis! - Fixes a CSS bug for users with JavaScript disabled -
#1465
ce3108cThanks @delucis! - Updates internal MDX, sitemap, and Expressive Code dependencies to the latest versions
0.17.3
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.
0.17.2
Patch Changes
-
#1442
1a642e4Thanks @delucis! - Fixes URLs in language picker for sites withbuild.format: 'file' -
#1440
2ea1e88Thanks @hippotastic! - Adds JS support to the@astrojs/starlight/expressive-codeexport to allow importing from non-TS environments.
0.17.1
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
0.17.0
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
0.16.0
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); }
0.15.4
Patch Changes
- #1378
0f4a31dThanks @delucis! - Updates dependencies:@astrojs/mdx,@astrojs/sitemap, andastro-expressive-code
0.15.3
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
0.15.2
Patch Changes
-
#1254
e9659e8Thanks @Pukimaa! - Adds Open Collective social link icon -
#1295
c3732a9Thanks @juchym! - Improve Ukrainian UI translations
0.15.1
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.
0.15.0
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: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
-
#1226
909afa2Thanks @tlandmangh! - Add Dutch translations of default aside labels -
#1243
ee234ebThanks @khajimatov! - Fix typo in Russian untranslated content notice -
#1170
bcc2301Thanks @tmcw! - Fix timezone-reliance in LastUpdated
0.14.0
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
0.13.1
Patch Changes
-
#1111
cb19d07Thanks @at-the-vr! - Fix minor punctuation typo in Hindi UI string -
#1156
631c5aeThanks @votemike! - Updates@astrojs/sitemapdependency to the latest version -
#1109
0c25c1fThanks @HiDeoo! - Internal: fix import issue with expressive-code
0.13.0
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
0.12.1
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
0.12.0
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
-
#1004
7f92213Thanks @nunhes! - Add Galician language support -
#1003
f1fdb50Thanks @delucis! - Internal: refactor translation string loading to make translations available to Starlight integration code
0.11.2
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
0.11.1
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
0.11.0
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:
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 Page head: - tag: title content: 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 page template: splash # Disable unwanted footer elements as needed editUrl: false lastUpdated: false prev: false next: 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
0.10.4
Patch Changes
-
#789
2528fb0Thanks @delucis! - Update bundled version of@astrojs/mdxto v1.1.0 -
#778
957d2c3Thanks @jermanuts! - Improve Arabic UI translations
0.10.3
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
0.10.2
Patch Changes
-
#735
2da8692Thanks @delucis! - Use Starlight font custom property in Pagefind modal -
#735
2da8692Thanks @delucis! - Fix RTL styling in Pagefind modal -
#739
a9de4a7Thanks @radenpioneer! - Add Indonesian UI translation -
#747
7589515Thanks @nirtamir2! - Add Hebrew UI translations
0.10.1
Patch Changes
-
#726
f3157c6Thanks @delucis! - Fix a rare bug in table of contents when handling headings that increase by more than one level on a page. -
#715
e726155Thanks @itsmatteomanf! - feat: prevent scroll on body when search is open
0.10.0
Minor Changes
Patch Changes
-
#708
136cfb1Thanks @julien-deramond! - Fix main content column width for pages without a table of contents -
#682
660a5f5Thanks @vedmalex! - Add Russian language support
0.9.1
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
0.9.0
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.
0.8.1
Patch Changes
- #612
1b367e3Thanks @KubaJastrz! - Avoid applying hovered<select>text color to its<options>
0.8.0
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
0.7.3
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
0.7.2
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.
0.7.1
Patch Changes
-
#488
da35556Thanks @mayank99! - Improved accessibility of LinkCard by only including the title as part of the link text, and using a pseudo-element to keep the card clickable. -
#489
35cd82eThanks @HiDeoo! - Respecthiddensidebar frontmatter property when no sidebar configuration is provided
0.7.0
Minor Changes
-
#441
0119a49Thanks @lorenzolewis! - Add support for hiding entries from an autogenerated sidebar:--- title: About this project sidebar: 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
0.6.1
Patch Changes
-
#442
42c0abdThanks @HiDeoo! - Increase Markdown table border contrast -
#443
cb8bcecThanks @delucis! - Add icons for Bitbucket, Gitter, CodePen, and Microsoft Teams -
#445
a80e180Thanks @HiDeoo! - Prevent repeated table of contents mark on mobile
0.6.0
Minor Changes
-
#424
4485d90Thanks @delucis! - Add support for customising autogenerated sidebar link labels from page frontmatter, overriding the page title:--- title: About this project sidebar: 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 first sidebar: 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
0.5.6
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
0.5.5
Patch Changes
0.5.4
Patch Changes
- #360
8415df6Thanks @HiDeoo! - Fix build warnings when using the TypeScriptverbatimModuleSyntaxcompiler option
0.5.3
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
0.5.2
Patch Changes
- #343
d618678Thanks @delucis! - Fix escaping of non-relative user config file paths for custom CSS and logos
0.5.1
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
0.5.0
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
- #318
5db3e6eThanks @delucis! - Support relative paths in Starlight config forcustomCSSandlogopaths
0.4.2
Patch Changes
0.4.1
Patch Changes
-
#300
377a25dThanks @cbontems! - Fix broken link on 404 page whendefaultLocale: 'root'is set inastro.config.mjs -
#289
dffca46Thanks @RyanRBrown! - Fix saturation of purple text in light theme -
#301
d47639dThanks @delucis! - Enable inline stylesheets for Astro versions ≥2.6.0
0.4.0
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
0.3.1
Patch Changes
-
#257
0502327Thanks @JosefJezek! - Add Czech language support -
#261
2062b9eThanks @delucis! - Fix autogenerated navigation for pages using fallback content
0.3.0
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
0.2.0
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
-
#208
09fc565Thanks @delucis! - Update@astrojs/mdxand@astrojs/sitemapto latest -
#216
54905c5Thanks @morinokami! - Encode heading id when finding current link
0.1.4
Patch Changes
-
#190
a3809e4Thanks @gabrielemercolino! - Added Italian language support -
#193
c9ca4ebThanks @BryceRussell! - Fix bottom padding for sidebar on larger screen sizes
0.1.3
Patch Changes
-
#183
89e0a04Thanks @delucis! - Fix disclosure caret rotation in sidebar sub-groups -
#177
bdafdb0Thanks @rviscomi! - Fix Markdown table overflow -
#185
4844915Thanks @delucis! - Support setting an SVG as the hero image file
0.1.2
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
0.1.1
Patch Changes
-
#155 Thanks @thomasbnt! - Add French language support
-
#158
92d82f5Thanks @kevinzunigacuellar! - Fix word wrapping in search modal on narrow screens
0.1.0
Minor Changes
0.0.19
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
0.0.18
Patch Changes
0.0.17
Patch Changes
-
#105
55fec5dThanks @delucis! - Add<Card>and<CardGrid>components for landing pages and other uses
0.0.16
Patch Changes
-
#103
ccb919dThanks @delucis! - Support adding a hero section to pages -
#101
6a2c0dfThanks @TheOtterlord! - Add better error messages for starlight config
0.0.15
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
0.0.14
Patch Changes
-
#95
de24b54Thanks @delucis! - Support translations in sidebar config -
#97
2d51762Thanks @morinokami! - Add Japanese language support
0.0.13
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
0.0.12
Patch Changes
- #85
c86c1d6Thanks @BryceRussell! - Improve outside click detection on the search modal
0.0.11
Patch Changes
0.0.10
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
0.0.9
Patch Changes
-
#72
3dc1d0cThanks @delucis! - Fix vertical alignment of social icons in site header -
#63
823e351Thanks @liruifengv! - Make sidebar groups to collapsible -
#72
3dc1d0cThanks @delucis! - Fix image aspect ratio in Markdown content
0.0.8
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
0.0.7
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.
0.0.6
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.
0.0.5
Patch Changes
0.0.4
Patch Changes
-
#40
e22dd76Thanks @delucis! - Generate sitemaps for Starlight sites -
#38
623b577Thanks @delucis! - Add tab components for use in MDX.
0.0.3
Patch Changes
-
1f62c75Thanks @delucis! - Add repo, issues & homepage links to package.json -
#36
62265e4Thanks @delucis! - Collapse table of contents in dropdown on narrower viewports
0.0.2
Patch Changes
-
#35
ea999c4Thanks @delucis! - Add support for social media links in the site header. -
#33
833393aThanks @MoustaphaDev! - Import zod fromastro/zodto fix an issue related to importing theastro:contentvirtual module