Changelog

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

• 0.24.1

  Jun 9, 2024

  🐞 Patch Changes

  • #1978 a5ab8cd6 Thanks @kylewlacy! - Add new social icon for Zulip

  • #1962 2ef19a94 Thanks @torn4dom4n! - Updates Vietnamese UI translations

  • #1976 5a61f73c Thanks @jsparkdev! - Updates Korean UI translations

  • #1987 0b8a8439 Thanks @HiDeoo! - Fixes issues with the locale text direction detection mechanism in some environments like WebContainers or Bun.

• 0.24.0

  Jun 5, 2024
  

  🍿 Minor Changes

  • #1841 ee0cd38a Thanks @HiDeoo! - Adds support for Astro.currentLocale and Astro’s i18n routing.

    ⚠️ Potentially breaking change: Starlight now configures Astro’s i18n option for you based on its locales config.

    If you are currently using Astro’s i18n option as well as Starlight’s locales option, you will need to remove one of these. In general we recommend using Starlight’s locales, but if you have a more advanced configuration you may choose to keep Astro’s i18n config instead.

  • #1958 081d1a96 Thanks @delucis! - Allows users to opt into displaying a “Built with Starlight” link in the site footer

  • #1530 dd64836a Thanks @kevinzunigacuellar! - Adds a new <Badge> component

• 0.23.4

  Jun 5, 2024

  🐞 Patch Changes

  • #1955 15ef1f4b Thanks @HiDeoo! - Reverts a change to prevent a numbering issue with the <Steps> component in future versions of Chrome.
• 0.23.3

  Jun 4, 2024

  🐞 Patch Changes

  • #1948 68c0c077 Thanks @HiDeoo! - Fixes a <Steps> component numbering issue with the next Chrome stable version when a step contains a nested list.

  • #1909 c98c7088 Thanks @joshka! - Adds Discourse to social icons

• 0.23.2

  May 28, 2024

  🐞 Patch Changes

  • #1913 7ebe8f75 Thanks @delucis! - Fixes support for Astro’s build: { format: 'preserve' } configuration option

  • #1941 2f3240c9 Thanks @astrobot-houston! - Adds icon support for .otf files in <FileTree>

• 0.23.1

  May 18, 2024

  🐞 Patch Changes

  • #1892 01de9be8 Thanks @delucis! - Internal refactor: simplify some CSS for the <details> element
• 0.23.0

  May 17, 2024
  

  🍿 Minor Changes

  • #1846 2de67039 Thanks @delucis! - Updates @astrojs/mdx to v3 and enables MDX optimization by default

    ⚠️ Potentially breaking change: MDX optimization speeds up builds (Starlight’s docs are building ~40% faster for example), but restricts some advanced MDX features. See full details in the MDX optimization documentation.

    Most Starlight users should be unaffected, but if you are using MDX files outside of Starlight pages with the components prop, you may see issues. You can disable optimization by adding MDX manually to your integrations array in astro.config.mjs:

    import { defineConfig } from 'astro/config';
     import mdx from '@astrojs/mdx';
    import starlight from '@astrojs/starlight';
    
    // https://astro.build/config
    export default defineConfig({
      integrations: [
        starlight({
          title: 'My docs',
          // ...
        }),
        mdx(),
      ],
    });

  • #1735 1a9ab50d Thanks @HiDeoo! - Adds custom styles for <details> and <summary> elements in Markdown content.

  • #1846 2de67039 Thanks @delucis! - ⚠️ BREAKING CHANGE: The minimum supported version of Astro is now 4.8.6

    Please update Astro and Starlight together:

    npx @astrojs/upgrade

• 0.22.4

  May 16, 2024

  🐞 Patch Changes

  • #1871 03bb126b Thanks @delucis! - Adds a blueSky icon and social link option

  • #1873 13f33b81 Thanks @ekfuhrmann! - Adds 1 new icon: alpine

  • #1857 32cdfaf0 Thanks @tarikcoskun! - Updates Turkish UI translations

  • #1736 cfa94a34 Thanks @julien-deramond! - Prevent list items from overflowing Markdown content

• 0.22.3

  May 14, 2024

  🐞 Patch Changes

  • #1838 9fe84754 Thanks @delucis! - Adds extra information to the errors thrown by the <Steps> component to help locate misformatted code

  • #1863 50be60bb Thanks @torn4dom4n! - Update Vietnamese translation

  • #1837 a33a1223 Thanks @delucis! - Adds three new icons: comment, comment-alt, heart

  • #1842 c7838636 Thanks @delucis! - Moves the href used in the site title link to Starlight’s route data object. This makes it possible for overrides to change the title link while reusing Starlight’s default component implemenation.

  • #1840 cb85563c Thanks @MiahaCybersec! - Adds 1 new icon: hackerone

• 0.22.2

  May 6, 2024

  🐞 Patch Changes

  • #1811 fe06aa13 Thanks @HiDeoo! - Fixes a <Tabs> sync issue when inconsistently using the icon prop or not on <TabItem> components.

  • #1826 52ea7381 Thanks @dragomano! - Updates Russian UI translations

• 0.22.1

  May 1, 2024

  🐞 Patch Changes

  • 1c0fc384 Thanks @HiDeoo! - Fixes an issue where the siteTitle property would not be set when using the <StarlightPage /> component.
• 0.22.0

  Apr 30, 2024
  

  🍿 Minor Changes

  • #640 7dc503ea Thanks @HiDeoo! - Adds support for syncing multiple sets of tabs on the same page.

  • #1620 ca0678ca Thanks @emjio! - Adds support for translating the site title

    ⚠️ Potentially breaking change: The shape of the title field 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 new siteTitle prop available to component overrides:

    ---
    import type { Props } from '@astrojs/starlight/props';
    
    // The site title for this page’s language:
    const { siteTitle } = Astro.props;
    ---

  • #1613 61493e55 Thanks @HiDeoo! - Adds new draft frontmatter option to exclude a page from production builds.

  • #640 7dc503ea Thanks @HiDeoo! - Updates the default line-height from 1.8 to 1.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 749ddf85 Thanks @jacobdalamb! - Updates astro-expressive-code dependency to the latest minor release (0.35) and exposes a new @astrojs/starlight/expressive-code/hast module for users who need to use Expressive Code’s version of hast.

    This includes a potentially breaking change if you use custom Expressive Code plugins. See the Expressive Code release notes for full details.

  • #1769 bd5f1cbd Thanks @ncjones! - Adds support for accessing frontmatter data as a variable when using Markdoc

  🐞 Patch Changes

  • #1788 681a4273 Thanks @dragomano! - Adds Russian translations for Expressive Code labels

  • #1780 4db6025a Thanks @MiahaCybersec! - Adds 1 new icon: signal

  • #1785 65009c9c Thanks @dreyfus92! - Adds 5 new icons: node, cloudflare, vercel, netlify and deno

  • #1786 d05d693a Thanks @delucis! - Fixes type inference for i18n strings added by extending the default schema

  • #1777 6949404b Thanks @HiDeoo! - Fixes an issue where TypeScript could fail to serialize the frontmatter schema when configured to emit declaration files

  • #1734 4493dcfa Thanks @delucis! - Refactors <ThemeSelect> custom element logic to improve performance

  • #1731 f08b0dff Thanks @techfg! - Fixes responding to system color scheme changes when theme is auto

  • #1793 2616f0c7 Thanks @Mrahmani71! - Updates the Farsi UI translations

• 0.21.5

  Apr 9, 2024

  🐞 Patch Changes

  • #1728 0a75680d Thanks @delucis! - Adds 1 new icon: pkl

  • #1709 c5cd1811 Thanks @HiDeoo! - Fixes a UI strings translation issue for sites configured with a single non-root language different from English.

  • #1723 3b29b3ab Thanks @OliverSpeir! - Fixes accessibility by using aria-selected="false" for inactive tabs instead of removing aria-selected="true" in the tablist of Starlight’s <Tabs> component

  • #1706 f171ac4d Thanks @jorenbroekema! - Fixes some minor type errors