Skip to content

Releases: withastro/starlight

@astrojs/[email protected]

09 Dec 17:10
7f0a519

Choose a tag to compare

Patch Changes

  • #3603 30f6e7f Thanks @delucis! - Fixes support for providing an absolute URL to Starlight’s favicon configuration option

@astrojs/[email protected]

28 Nov 17:09
4c0cd60

Choose a tag to compare

Minor Changes

  • #3491 28810f0 Thanks @JusticeMatthew! - Changes text overflow styling in Markdown content

    ⚠️ Potentially breaking change: This release switches the overflow-wrap CSS style for common elements to break-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 239698c Thanks @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 ca7b771 Thanks @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 uses margin-bottom and border-bottom to highlight the current tab. This is now done with a box-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 1cf50eb Thanks @jacobdalamb! - Updates the default sans-serif system font stack, dropping support for the -apple-system and BlinkMacSystemFont font 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 f61f99d Thanks @HiDeoo! - Adds a new markdown.processedDirs configuration 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.

@astrojs/[email protected]

24 Nov 18:54
37d0af0

Choose a tag to compare

Patch Changes

  • #3555 547dc30 Thanks @Its-Just-Nans! - Improves the error message thrown when using a file in the public/ directory with Starlight’s customCss configuration option

  • #3496 b78fda4 Thanks @delucis! - Fixes invalid <head> output when configuration is missing:

    • Omits <meta property="og:description" /> if Starlight’s description option is unset
    • Omits <link rel="canonical" /> and <meta property="og:url" /> if Astro’s site option is unset
  • #3511 8727df1 Thanks @astrobot-houston! - Updates the seti:gitlab icon to match latest version from Seti UI Icons

@astrojs/[email protected]

31 Oct 14:41
27e8b6c

Choose a tag to compare

Patch Changes

@astrojs/[email protected]

31 Oct 14:41
27e8b6c

Choose a tag to compare

Patch Changes

  • #3500 7700456 Thanks @delucis! - This is the first release published with OIDC trusted publishing.

@astrojs/[email protected]

31 Oct 14:41
27e8b6c

Choose a tag to compare

Patch Changes

  • #3500 7700456 Thanks @delucis! - This is the first release published with OIDC trusted publishing.

@astrojs/[email protected]

31 Oct 14:41
27e8b6c

Choose a tag to compare

Patch Changes

  • #3500 7700456 Thanks @delucis! - This is the first release published with OIDC trusted publishing.

@astrojs/[email protected]

15 Oct 15:33
af61ee1

Choose a tag to compare

Patch Changes

  • #3479 2fec483 Thanks @gboubeta-uvigo! - Updates Galician UI translations

  • #3457 c6c0c51 Thanks @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 Starlight head configuration option or the head frontmatter field will now override the default sitemap link tag added by Starlight.

    This change ensures that users manually adding the @astrojs/sitemap integration to the Astro integrations array for more fine-grained control over sitemap generation and also using the filenameBase integration option can customize the sitemap link tag in the head.

  • #3448 1fc7501 Thanks @dionysuzx! - Enlarges the Farcaster icon to better match other social icons

  • #3473 07204dd Thanks @gboubeta! - Fixes a typo in Galician table of contents label

@astrojs/[email protected]

19 Sep 14:00
eb8ac77

Choose a tag to compare

Minor Changes

  • #3427 c3b2d0f Thanks @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 3364af3 Thanks @HiDeoo! - Makes head entry parsing stricter in Starlight config and content frontmatter.

    ⚠️ Potentially breaking change: Previously Starlight would accept a head entry for a meta tag defining some content which generates invalid HTML as <meta> is a void element which cannot have any child nodes. Now, it is an error to define a meta tag including some content.

    If you see errors after updating, look for head entries in the Starlight configuration in the astro.config.mjs file or in the frontmatter of your content files that include a content property for a meta tag. To fix the error, move the content property to the attrs object 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 2018c31 Thanks @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

  • #3423 a0d0670 Thanks @andersk! - Fixes HTML validity in sidebar groups by ensuring <summary> is the first child of <details>

@astrojs/[email protected]

13 Sep 13:24
266eed4

Choose a tag to compare

Patch Changes