Changelog

• 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>

• 0.25.2

  Jul 23, 2024

  🐞 Patch Changes

  • #2126 ada51ee Thanks @essential-randomness! - Adds support for markdown formatting in aside titles

  • #2135 9bbb969 Thanks @oluwatobiss! - Adds Pinterest social icon

• 0.25.1

  Jul 10, 2024

  🐞 Patch Changes

  • #2122 359a642 Thanks @HiDeoo! - Fixes an i18n configuration issue for multilingual sites when using Astro’s i18n config with prefixDefaultLocale set to false.

  • #2107 61e223b Thanks @sanabel-al-firdaws! - Updates Arabic UI translations

  • #2105 81f8a2c Thanks @delucis! - Fixes an edge case in custom pagination link processing

    Custom link values for prev/next in 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 464685a Thanks @evadecker! - Improves styling of <hr>, <blockquote>, and <code> within asides

• 0.25.0

  Jul 5, 2024
  

  🍿 Minor Changes

  • #2025 47f32c1 Thanks @HiDeoo! - Removes the / search shortcut for accessibility reasons.

    ⚠️ Potentially breaking change: The search.shortcutLabel UI string has been removed. If you were using this string in your custom UI, you will need to update your code.

  • #2064 c5b47cb Thanks @SnowDingo! - Improves styling of Markdown tables to work better in different contexts, including against different background colours like when used in asides.

  • #2031 2bab648 Thanks @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 link and items was considered valid, with items being ignored. Now, it is an error to include more than one of link, items, or autogenerate in a sidebar entry.

    If you see errors after updating, look for sidebar entries in the Starlight configuration in astro.config.mjs that include too many keys and remove the one that was previously ignored.

  • #1874 eeba06e Thanks @lorenzolewis! - Adds a new syntax for specifying sidebar link items for internal links

    You can now specify an internal page using only its slug, either as a string, or as an object with a slug property:

    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 f0181d2 Thanks @andrii-bodnar! - Updates the Ukrainian UI translations
• 0.24.5

  Jun 28, 2024

  🐞 Patch Changes

  • #2062 5ac0ac6 Thanks @evadecker! - Increase theme and language select inline padding

  • #2056 87e9ad0 Thanks @HiDeoo! - Fixes an issue preventing remark plugins injected by Starlight plugins to handle Markdown text and leaf directives.

  • #2063 3ee1a94 Thanks @delucis! - Translate fileTree.directory and aside.* UI string into Norwegian (Bokmål).

  • #2054 dbfd3ee Thanks @HiDeoo! - Fixes an issue when using the <StarlightPage> component in a custom page with a user-defined srcDir configuration.

• 0.24.4

  Jun 20, 2024

  🐞 Patch Changes

  • #2038 87f3f92 Thanks @dragomano! - Updates Russian UI translations

  • #2043 53f4cd4 Thanks @playmr365! - Updates Czech UI translations

  • #2041 8af5a60 Thanks @HiDeoo! - Fixes <Steps> numbering bug caused by Chrome v126 CSS counter rewrite

• 0.24.3

  Jun 18, 2024

  🐞 Patch Changes

  • #2028 af81ad3 Thanks @HiDeoo! - Fixes a search dialog height issue in Safari.

  • #2022 80f82b1 Thanks @playmr365! - Updates Czech UI translations

• 0.24.2

  Jun 12, 2024

  🐞 Patch Changes

  • #2008 40359c7 Thanks @vnepogodin! - Add Slovak language UI translation.

  • #2004 0aa2f06 Thanks @liruifengv! - Removes an outdated export in package.json

  • #2007 44ca490 Thanks @delucis! - Updates internal dependencies

  • #1993 60165b2 Thanks @HiDeoo! - Fixes an i18n configuration issue when using a single root locale.