Skip to content
Starlight Changelogs

Starlight Changelog

0.15.3

Patch Changes

0.15.2

Patch Changes

0.15.1

Patch Changes

0.15.0

Minor Changes

  • #1238 02a808e Thanks @delucis! - Add support for Astro v4, drop support for Astro v3

    ⚠️ BREAKING CHANGE Astro v3 is no longer supported. Make sure you update Astro and any other integrations at the same time as updating Starlight.

    Use the new @astrojs/upgrade command to upgrade Astro and Starlight together:

    Terminal window
    npx @astrojs/upgrade

  • #1242 d8fc9e1 Thanks @delucis! - Enables link prefetching on hover by default

    Astro v4’s prefetch support is now enabled by default. If prefetch is not set in astro.config.mjs, Starlight will use prefetch: { prefetchAll: true, defaultStrategy: 'hover' } by default.

    If you want to preserve previous behaviour, disable link prefetching in astro.config.mjs:

    import { defineConfig } from 'astro/config';
    import starlight from '@astrojs/starlight';
    

    export default defineConfig({
      // Disable link prefetching:
      prefetch: false,
    

      integrations: [
        starlight({
          // ...
        }),
      ],
    });

Patch Changes

0.14.0

Minor Changes

  • #1144 7c0b8cb Thanks @delucis! - Adds a configuration option to disable site indexing with Pagefind and the default search UI

  • #942 efd7fdc Thanks @HiDeoo! - Adds plugin API

    See the plugins reference to learn more about creating plugins for Starlight using this new API.

  • #1135 e5a863a Thanks @delucis! - Exposes localized UI strings in route data

    Component overrides can now access a labels object in their props which includes all the localized UI strings for the current page.

  • #1162 00d101b Thanks @delucis! - Adds support for extending Starlight’s content collection schemas

0.13.1

Patch Changes

0.13.0

Minor Changes

  • #1023 a3b80f7 Thanks @kevinzunigacuellar! - Respect the trailingSlash and build.format Astro options when creating Starlight navigation links.

    ⚠️ Potentially breaking change: This change will cause small changes in link formatting for most sites. These are unlikely to break anything, but if you care about link formatting, you may want to change some Astro settings.

    If you want to preserve Starlight’s previous behavior, set trailingSlash: 'always' in your astro.config.mjs:

    import { defineConfig } from 'astro/config';
    import starlight from '@astrojs/starlight';
    

    export default defineConfig({
      trailingSlash: 'always',
      integrations: [
        starlight({
          // ...
        }),
      ],
    });

  • #742 c6a4bcb Thanks @hippotastic! - Adds Expressive Code as Starlight’s default code block renderer

    ⚠️ Potentially breaking change: This addition changes how Markdown code blocks are rendered. By default, Starlight will now use Expressive Code. If you were already customizing how code blocks are rendered and don’t want to use the features provided by Expressive Code, you can preserve the previous behavior by setting the new config option expressiveCode to false.

    If you had previously added Expressive Code manually to your Starlight project, you can now remove the manual set-up in astro.config.mjs:

    • Move your configuration to Starlight’s new expressiveCode option.
    • Remove the astro-expressive-code integration.

    For example:

    import starlight from '@astrojs/starlight';
    import { defineConfig } from 'astro/config';
     import expressiveCode from 'astro-expressive-code';
    

    export default defineConfig({
      integrations: [
       expressiveCode({
         themes: ['rose-pine'],
       }),
        starlight({
          title: 'My docs',
         expressiveCode: {
           themes: ['rose-pine'],
         },
        }),
      ],
    });

    Note that the built-in Starlight version of Expressive Code sets some opinionated defaults that are different from the astro-expressive-code defaults. You may need to set some styleOverrides if you wish to keep styles exactly the same.

  • #517 5b549cb Thanks @liruifengv! - Add i18n support for default aside labels

Patch Changes

0.12.1

Patch Changes

  • #1069 b86f360 Thanks @Genteure! - Fix sidebar highlighting and navigation buttons for pages with path containing non-ASCII characters

  • #1025 0d1e75e Thanks @HiDeoo! - Internal: fix import issue in translation string loading mechanism

  • #1044 a5a9754 Thanks @HiDeoo! - Fix last updated dates for pages displaying fallback content

  • #1049 c27495d Thanks @HiDeoo! - Expose Markdown content styles in @astrojs/starlight/style/markdown.css

0.12.0

Minor Changes

  • #995 5bf4457 Thanks @kevinzunigacuellar! - Adds support for adding sidebar badges to group headings

  • #988 977fe13 Thanks @magicDGS! - Include social icon links in mobile menu

  • #280 72cca2d Thanks @cbontems! - Support light & dark variants of the hero image.

    ⚠️ Potentially breaking change: The hero.image schema is now slightly stricter than previously.

    The hero.image.html property can no longer be used alongside the hero.image.alt or hero.image.file properties. Previously, html was ignored when used with file and alt was ignored when used with html. Now, those combinations will throw errors. If you encounter errors, remove the image.hero property that is not in use.

Patch Changes

  • #1004 7f92213 Thanks @nunhes! - Add Galician language support

  • #1003 f1fdb50 Thanks @delucis! - Internal: refactor translation string loading to make translations available to Starlight integration code

0.11.2

Patch Changes