Releases: withastro/starlight
@astrojs/[email protected]
Minor Changes
-
#1485
2cb3578
Thanks @timokoessler! - Add support for setting html attributes of hero action links -
#1175
dd11b95
Thanks @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
97bf523
Thanks @delucis! - Adds a new<Aside>
componentThe new component is in addition to the existing custom Markdown syntax.
@astrojs/[email protected]
@astrojs/[email protected]
Minor Changes
-
#1454
1d9ef56
Thanks @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
1d9ef56
Thanks @Fryuni! - Enables Astro’sexperimental.globalRoutePriority
option 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
@astrojs/[email protected]
@astrojs/[email protected]
Patch Changes
-
#1461
2e17880
Thanks @liruifengv! - Improves the table of contents title translation in Simplified Chinese -
#1462
4741ccc
Thanks @delucis! - Fixes overflow of very long site titles on narrow viewports -
#1459
9a8e0ec
Thanks @delucis! - Fixes a bug where table of contents highlighting could break given very specific combinations of content and viewport size -
#1458
8c88642
Thanks @delucis! - Silences i18n content collection warnings for projects without custom translations.
@astrojs/[email protected]
@astrojs/[email protected]
Patch Changes
-
#1437
655aed4
Thanks @hippotastic! - Adds Starlight-specific types todefineEcConfig
function and exportsStarlightExpressiveCodeOptions
.This provides Starlight types and IntelliSense support for your Expressive Code configuration options inside an
ec.config.mjs
file. See the Expressive Code documentation for more information. -
#1420
275f87f
Thanks @abdelhalimjean! - Fix rarefont-family
issue if users have a font installed with a name of""
-
#1365
a0af7cc
Thanks @kevinzunigacuellar! - Correctly format Pagefind search result links whentrailingSlash: 'never'
is used
@astrojs/[email protected]
Minor Changes
-
#1389
21b3620
Thanks @connor-baer! - Adds newdisable404Route
config option to disable injection of Astro’s default 404 route -
#1395
ce05dfb
Thanks @hippotastic! - Adds a new<Code>
component to render dynamic code strings with Expressive Code
@astrojs/[email protected]
Minor Changes
-
#1383
490c6ef
Thanks @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 internalvirtual:starlight/components
module, this no longer exists.
Update your imports to use the individual virtual modules now available for each component, for examplevirtual:starlight/components/EditLink
. -
#1151
134292d
Thanks @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.md
andsrc/content/docs/guides/example.md
will now both be included andsrc/content/docs/guides.md
is treated in the same way asrc/content/docs/guides/index.md
file would be. -
#1386
0163634
Thanks @delucis! - Tightensline-height
on<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
8398432
Thanks @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.5rem
to1rem
. - 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
773880d
Thanks @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); }