Changelog

• 0.29.2

  Nov 19, 2024

  🐞 Patch Changes

  • #2616 128cc51 Thanks @delucis! - Fixes an edge case to correctly avoid a trailing slash when navigating from a root locale homepage to another language via Starlight’s language switcher when trailingSlash: 'never' is set
• 0.29.1

  Nov 19, 2024

  🐞 Patch Changes

  • #2611 6059d96 Thanks @HiDeoo! - Fixes a UI string type issue in projects with multiple data content collections.

  • #2606 10b15a7 Thanks @delucis! - Makes <CardGrid> more resilient to complex child content on smaller viewports

  • #2605 ec7ab4f Thanks @brianzelip! - Exposes SidebarPersister component in package exports for use in custom overrides

  • #2614 9a31980 Thanks @HiDeoo! - Fixes an issue with custom pages using the <StarlightPage /> component and a custom sidebar missing highlighting for the active page and navigation links.

  • #2600 49aef17 Thanks @jdevega! - Adds Backstage social icon

  • #2613 a73780f Thanks @delucis! - Fixes support for sidebar frontmatter options in sidebar entries using slug or the string shorthand for internal links

• 0.29.0

  Nov 8, 2024
  

  🍿 Minor Changes

  • #2551 154c8e3 Thanks @hippotastic! - Updates the astro-expressive-code dependency to the latest version (0.38).

    The new version allows using ec.config.mjs to selectively override individual Expressive Code styles and settings provided by Starlight themes and plugins, speeds up Shiki language loading, and adds the config option expressiveCode.shiki.injectLangsIntoNestedCodeBlocks. See the Expressive Code release notes for full details.

  • #2252 6116db0 Thanks @HiDeoo! - Improves build performance for sites with large sidebars

    This 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 a4c8edd Thanks @HiDeoo! - Improves the accessibility of asides and tabs by removing some unnecessary HTML landmarks.

  🐞 Patch Changes

  • #2579 241966b Thanks @RafidMuhymin! - Adds social link icon for Nostr
• 0.28.6

  Nov 4, 2024

  🐞 Patch Changes

  • #2565 236467b Thanks @HiDeoo! - Fixes an issue with custom UI strings defined in YAML files not being loaded in some contexts.
• 0.28.5

  Nov 1, 2024

  🐞 Patch Changes

  • #2546 bf42300 Thanks @HiDeoo! - Fixes an issue where i18n content collection related errors, e.g. malformed JSON or YAML, would not be reported.

  • #2548 07673c8 Thanks @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 91e1dd7 Thanks @HiDeoo! - Fixes a Firefox Markdown content rendering issue for text sentences separated by a line break.

  • #2524 1b46783 Thanks @jsparkdev! - Fixes a broken link to Astro’s Docs in an error message

• 0.28.4

  Oct 28, 2024

  🐞 Patch Changes

  • #2444 d585b3e Thanks @HiDeoo! - Fixes a UI string translation issue for languages with a region subtag.

  • #2518 0f69db8 Thanks @morinokami! - Updates Japanese UI translations

  • #2507 bd6ced5 Thanks @HiDeoo! - Fixes a table of contents highlighting issue after resizing the window.

  • #2444 d585b3e Thanks @HiDeoo! - Refactors various components to use the new built-in localization system to access translated UI strings.

• 0.28.3

  Oct 7, 2024

  🐞 Patch Changes

  • #2408 0b4823d Thanks @HiDeoo! - Fixes a link formatting issue when using the Astro build.format option set to file with a base.

  • #2380 7b451cf Thanks @delucis! - Loosen Starlight’s i18n schema to pass through unknown keys

  • #2388 6bba3d8 Thanks @HiDeoo! - Fixes a potential type-checking issue in Starlight projects.

  • #2443 a0f40b3 Thanks @kevinzunigacuellar! - Fixes CSS issue where bottom padding is not applied in the search dialog.

• 0.28.2

  Sep 19, 2024

  🐞 Patch Changes

  • #2377 a257b83 Thanks @HiDeoo! - Fixes an issue with synced <Tabs> components containing nested <Tabs> causing tab panels to not render correctly.
• 0.28.1

  Sep 18, 2024

  🐞 Patch Changes

  • #2334 79b9ade Thanks @HiDeoo! - Fixes an issue with Expressive Code UI labels not displaying correctly.
• 0.28.0

  Sep 18, 2024
  

  🍿 Minor Changes

  • #1923 5269aad Thanks @HiDeoo! - Overhauls the built-in localization system which is now powered by the i18next library 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.labels props 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 new Astro.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 7286220 Thanks @HiDeoo! - Adds support for translating sidebar badges.

  • #1923 5269aad Thanks @HiDeoo! - ⚠️ BREAKING CHANGE: The minimum supported version of Astro is now 4.14.0

    Please update Astro and Starlight together:

    npx @astrojs/upgrade

  🐞 Patch Changes

  • #2327 d7a295e Thanks @tritao! - Fixes restoration of remark directives for nodes with custom data attached.
• 0.27.1

  Sep 8, 2024

  🐞 Patch Changes

  • #2303 f92791a Thanks @delucis! - Fixes resolution for the internal module Git virtual module in projects with special characters in the file path
• 0.27.0

  Sep 6, 2024
  

  🍿 Minor Changes

  • #1255 6f3202b Thanks @Fryuni! - Adds support for server-rendered Starlight pages.

    When building a project with hybrid or server output mode, a new prerender option on Starlight config can be set to false to make all Starlight pages be rendered on-demand:

    export default defineConfig({
      output: 'server',
      integrations: [
        starlight({
          prerender: false,
        }),
      ],
    });

  🐞 Patch Changes

  • #2242 756e85e Thanks @delucis! - Refactors the logic for persisting and restoring sidebar state across navigations for better performance on slow or busy devices

  • #1255 6f3202b Thanks @Fryuni! - Improves performance of computing the last updated times from Git history.

    Instead of executing git for each docs page, it is now executed twice regardless of the number of pages.

  • #1255 6f3202b Thanks @Fryuni! - Fixes last updated times on projects with custom srcDir

• 0.26.4

  Sep 6, 2024

  🐞 Patch Changes

  • #2288 b15f725 Thanks @matthewp! - Safely handle Zod errors

    Prevents bugs where errors without the .received props would through and cause builds to fail unnecessarily.

• 0.26.3

  Sep 4, 2024

  🐞 Patch Changes

  • #2281 5062d30 Thanks @HiDeoo! - Fixes a potential text rendering issue that could include extra whitespaces for text containing colons.

  • #2279 62d59e2 Thanks @HiDeoo! - Fixes an issue with frontmatter schemas containing collection references used with the <StarlightPage /> component and an Astro version greater than 4.14.0.

• 0.26.2

  Sep 2, 2024

  🐞 Patch Changes

  • #2273 746e0cd Thanks @delucis! - Fixes type error when using Starlight with Astro v4.15

  • #2265 25b661e Thanks @SeraphicRav! - Adds TikTok social icon

  • #2272 d1969dd Thanks @o-az! - Adds new icon: jsr

  • #2250 c0a6166 Thanks @HiDeoo! - Removes internal E2E tests from the package published to the npm registry.

  • #2253 72bc76a Thanks @HiDeoo! - Fixes an issue preventing to use the class attribute in hero action link buttons.

• 0.26.1

  Aug 16, 2024

  🐞 Patch Changes

  • #2219 74d4716 Thanks @HiDeoo! - Fixes a sidebar persistence issue when navigating between pages with different sidebar content.
• 0.26.0

  Aug 16, 2024
  

  🍿 Minor Changes

  • #1784 68f56a7 Thanks @HiDeoo! - Adds <LinkButton> component for visually distinct and emphasized call to action links

  • #2150 9368494 Thanks @delucis! - Adds state persistence across page navigations to the main site sidebar

  • #2087 caa84ea Thanks @HiDeoo! - Adds persistence to synced <Tabs> so that a user’s choices are reflected across page navigations.

  • #2051 ec3b579 Thanks @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 68f56a7 Thanks @HiDeoo! - Changes the hero component action button default variant from minimal to primary.

    ⚠️ BREAKING CHANGE: If you want to preserve the previous appearance, hero component action buttons previously declared without a variant will need to be updated to include the variant property with the value minimal.

    hero:
      actions:
        - text: View on GitHub
          link: https://github.com/astronaut/my-project
          icon: external
         variant: minimal

  • #2168 e044fee Thanks @HiDeoo! - ⚠️ BREAKING CHANGE: Updates the <StarlightPage /> component sidebar prop to accept an array of SidebarItems like the main Starlight sidebar configuration in astro.config.mjs.

    This change simplifies the definition of sidebar items in the <StarlightPage /> component, allows for shared sidebar configuration between the global sidebar option 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 custom sidebar configuration, you will need to update the sidebar prop to an array of SidebarItem objects.

    For example, the following custom page with a custom sidebar configuration defines a “Resources” group with a “New” badge, a link to the “Showcase” page which is part of the docs content collection, and a link to the Starlight website:

    <StarlightPage
      frontmatter={{ 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:

    <StarlightPage
      frontmatter={{ 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.

• 0.25.5

  Aug 13, 2024

  🐞 Patch Changes

  • #2171 c8258d7 Thanks @delucis! - Improves build performance slightly for bigger sites

  • #2199 91557fd Thanks @connorjs! - Adds Azure DevOps (azureDevOps) icon for use in social links.

• 0.25.4

  Aug 6, 2024

  🐞 Patch Changes

  • #2155 8bed886 Thanks @delucis! - Improves page load performance on slower devices

  • #2167 9ac7725 Thanks @delucis! - Fixes an issue detecting the built-in locale when running Starlight in a web container environment on Firefox

  • #2166 4f12049 Thanks @delucis! - Updates @astrojs/mdx, @astrojs/sitemap, astro-expressive-code, unified, and vfile dependencies to the latest version

• 0.25.3

  Jul 29, 2024

  🐞 Patch Changes

  • #2154 0b381d5 Thanks @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 6757d97 Thanks @astrobot-houston! - Updates file tree icon mapping to correctly map .cjs and .mjs extensions in several contexts

  • #2156 904ad47 Thanks @delucis! - Fixes builds for projects with a space in their pathname

  • #2137 703903b Thanks @cevdetardaharan! - Removes twitter:title and twitter:description meta tags from <head>