Skip to content
Starlight Changelogs

All versions since 0.4.0
All versions

0.4.0

   🚨 Breaking Changes

  • Bump minimum required Astro version to 3.2.0 and Starlight to 0.11.0  -  by @HiDeoo (d231b)

  • Use Starlight component overrides for custom UI  -  by @HiDeoo (cdf7c) You must update your configuration to use the new Starlight component overrides:

    starlight({
      components: {
        MarkdownContent: 'starlight-blog/overrides/MarkdownContent.astro',
        Sidebar: 'starlight-blog/overrides/Sidebar.astro',
        ThemeSelect: 'starlight-blog/overrides/ThemeSelect.astro',
      },
    }),
    View changes on GitHub

0.5.0

   🚨 Breaking Changes

  • Bumps minimum required Astro version to 4.2.7 and Starlight to 0.19.0  -  by @HiDeoo (a9fc3)

  • Starlight Blog is now a Starlight plugin  -  by @HiDeoo (bbb9d)

    You will need to update your Astro configuration to remove the previous version and add the new version as a Starlight plugin in your astro.config.mjs file:

    import starlight from "@astrojs/starlight";
    import { defineConfig } from "astro/config";
    import starlightBlog from 'starlight-blog';
    

    export default defineConfig({
      // …
      integrations: [
       starlightBlog(),
        starlight({
         plugins: [starlightBlog()],
          title: "My Docs",
        }),
      ],
    });

    You will also need to update Starlight’s frontmatter schema in the src/content/config.ts file:

     import { docsSchema, i18nSchema } from '@astrojs/starlight/schema';
     import { defineCollection } from 'astro:content';
    import { docsAndBlogSchema } from 'starlight-blog/schema';
    import { blogSchema } from 'starlight-blog/schema';
    

    export const collections = {
     docs: defineCollection({ schema: docsAndBlogSchema }),
     docs: defineCollection({ schema: docsSchema({ extend: blogSchema() }) }),
      i18n: defineCollection({ type: 'data', schema: i18nSchema() }),
    }

   🚀 Features

  • Exports the StarlightBlogConfig TypeScript type representing the user’s plugin configuration  -  by @HiDeoo (012f5)
    View changes on GitHub

0.5.1

   🐞 Bug Fixes

  • Fixes issues when using the Astro base option  -  by @HiDeoo (6d893)
    View changes on GitHub

0.6.0

   🚀 Features

  • Respects the Astro trailingSlash option  -  by @HiDeoo (e87f6)
  • Adds new prevNextLinksOrder option to control if next links will point to the next blog post towards the past or the future  -  by @HiDeoo (0c12c)
  • Adds support for Markdown in blog post excerpts  -  by @HiDeoo (49cd5)
  • Adds new prefix option to configure the base prefix for all blog routes  -  by @HiDeoo (b6542)
  • Uses Starlight <LinkCard> component for prev/next links  -  by @HiDeoo (75528)

   🐞 Bug Fixes

  • Fixes a TypeScript type issue with the plugin configuration schema  -  by @HiDeoo (d1194)
    View changes on GitHub

0.7.0

   🚨 Breaking Changes

  • Bumps minimum required Starlight version to 0.22.1  -  by @HiDeoo (ed23e)

   🚀 Features

  • Add support for draft blog posts  -  by @HiDeoo (eebbb)
    View changes on GitHub

0.7.1

   🐞 Bug Fixes

  • Prevents the blog post and tag lists from being included in the Pagefind search index to avoid duplicated search results  -  by @HiDeoo (0f82e)
  • Prevents blog navigation links from being included in the Pagefind search index to avoid duplicated search results  -  by @HiDeoo (98967)
    View changes on GitHub

0.8.0

   🚀 Features

  • Adds an RSS feed to the generated blog  -  by @HiDeoo (e4ddb) The feature is automatically enabled when the Astro site option is set in astro.config.mjs.
    View changes on GitHub

0.8.1

   🚀 Features

  • Adds a social link to Starlight for the blog RSS feed  -  by @HiDeoo (c506b)

   🐞 Bug Fixes

  • Fixes an RSS feed image rendering issue by temporarily replacing images with a placeholder  -  by @HiDeoo (9f33e)
    View changes on GitHub

0.8.2

   🐞 Bug Fixes

  • Fixes a 404 RSS feed sidebar link error when using the Astro trailingSlash option set to always  -  by @HiDeoo (8e1d5)
    View changes on GitHub

0.8.3

   🐞 Bug Fixes

  • Hides table of content on the blog post and tag list pages  -  by @HiDeoo (55fc6)
    View changes on GitHub

0.9.0

   🚨 Breaking Changes

  • Bumps minimum required Starlight version to 0.24.0  -  by @HiDeoo (c8325)

  • Adds support for cover images  -  by @HiDeoo (fa1ca) You will need to update Starlight’s content collections configuration in the src/content/config.ts file:

     import { defineCollection } from 'astro:content';
     import { docsSchema } from '@astrojs/starlight/schema';
     import { blogSchema } from 'starlight-blog/schema'
    

    export const collections = {
      docs: defineCollection({ schema: docsSchema({ extend: blogSchema() }) }),
      docs: defineCollection({ schema: docsSchema({ extend: (context) => blogSchema(context) }) }),
    }

   🚀 Features

  • Uses Astro’s built-in optimized asset support for author profile images  -  by @HiDeoo (2baa6)
  • Uses Starlight built-in badges for draft status  -  by @HiDeoo (a6587)
    View changes on GitHub

0.9.1

   🐞 Bug Fixes

  • Fixes an issue that could cause duplicated pagination links to be rendered  -  by @HiDeoo (50d7c)
    View changes on GitHub

0.10.0

   🚀 Features

  • Adds support for specifying a blog post’s updated date  -  by @julien-deramond and @HiDeoo (569e0)
    View changes on GitHub

0.11.0

   🚨 Breaking Changes

  • Uses Starlight lastUpdated frontmatter field to display the update date of a blog post  -  by @HiDeoo (75205)
    View changes on GitHub

0.11.1

   🐞 Bug Fixes

  • Fixes a potential build error with recent Rollup versions  -  by @HiDeoo (6e213)
    View changes on GitHub

0.12.0

   🚀 Features

  • Adds new featured frontmatter field to mark a blog post as featured. Featured posts are listed in a dedicated group in the sidebar.  -  by @HiDeoo (93f06)
    View changes on GitHub

0.13.0

   🚀 Features

  • Adds author pages listing all posts by author  -  by @HiDeoo (b7bab)
  • Lists authors in the sidebar if there are multiple authors  -  by @HiDeoo (c22d7)
    View changes on GitHub

0.14.0

   🚨 Breaking Changes

  • Bumps minimum required Starlight version to 0.28.3  -  by @HiDeoo (ec996)

   🚀 Features

  • Adds support for multilingual blogs with routing and fallback content  -  by @HiDeoo (d2d7f)
  • Adds support for translating the blog title  -  by @HiDeoo (59462)
  • Adds support for Starlight UI translations API  -  by @HiDeoo (a9150)
  • Adds French UI translations  -  by @HiDeoo (fa4c3)
    View changes on GitHub

0.14.1

   🚀 Features

  • Adds Italian UI translations  -  by @casungo and @HiDeoo (6934b)
  • Adds German UI translations  -  by @trueberryless, Ergberg and @HiDeoo (af0c3)
    View changes on GitHub

0.15.0

   🚀 Features

  • Refactors full-text RSS feed to use the experimental Astro Container API  -  by @HiDeoo (2268e) This change fixes various rendering issues with MDX content or images.
    View changes on GitHub

0.16.0

Minor Changes

  • #100 679e509 Thanks @HiDeoo! - Adds support for Astro v5, drops support for Astro v4.

    ⚠️ BREAKING CHANGE: The minimum supported version of Starlight is now 0.30.0.

    Please follow the upgrade guide to update your project.

    Note that the legacy.collections flag is not supported by this plugin and you should update your collections to use Astro’s new Content Layer API.

    ⚠️ BREAKING CHANGE: The generated RSS feed no longer includes content of blog posts due to a regression in Astro v5. The feature will be restored in a future release. If you rely on this feature, please stay on a previous version of Starlight and Astro in the meantime.

0.16.1

Patch Changes

0.17.0

Minor Changes

  • #111 144e6b2 Thanks @HiDeoo! - ⚠️ BREAKING CHANGE: The minimum supported version of Starlight is now version 0.32.0.

    Please use the @astrojs/upgrade command to upgrade your project:

    Terminal window
    npx @astrojs/upgrade

  • #111 144e6b2 Thanks @HiDeoo! - ⚠️ BREAKING CHANGE: The Starlight Blog plugin no longer overrides the <Sidebar> component. If you were manually rendering starlight-blog/overrides/Sidebar.astro in a custom override, you can now remove it.

  • #111 144e6b2 Thanks @HiDeoo! - Adds a blog data object accessible on Starlight pages using Astro.locals.starlightBlog containing information about all the blog posts in your project. This can be useful for example to create a widget that lists recent blog posts on your homepage.

    See the “Blog Data” guide for more information.

  • #111 144e6b2 Thanks @HiDeoo! - Fixes a regression introduced in version 0.16.0 of the plugin where the generated RSS feed no longer included content of blog posts due to a bug in Astro.

0.17.1

Patch Changes

  • #113 b6f7122 Thanks @HiDeoo! - Fixes an issue where aside icons were not removed from RSS content.

0.17.2

Patch Changes

  • #115 90da130 Thanks @HiDeoo! - Improves build performance for large sites by adding a caching layer to blog entries and data.

0.17.3

Patch Changes

  • #120 24172db Thanks @HiDeoo! - Fixes a potential build issue for blogs with more than 20 posts also generating an RSS feed.

0.18.0

Minor Changes

  • #122 75dee60 Thanks @HiDeoo! - Respects Starlight convention to generate URLs with a trailing slash when using the trailingSlash: 'ignore' Astro configuration option (the default) as many common hosting providers redirect to URLs with a trailing slash by default.

0.19.0

Minor Changes

0.20.0

Minor Changes

  • #131 32d0fdd Thanks @HiDeoo! - ⚠️ BREAKING CHANGE: The minimum supported version of Starlight is now version 0.33.0.

    Please use the @astrojs/upgrade command to upgrade your project:

    Terminal window
    npx @astrojs/upgrade

0.21.0

Minor Changes

  • #139 6ed1559 Thanks @HiDeoo! - Displays cover images for blog posts in pages that list blog posts such as the blog index page.

  • #139 6ed1559 Thanks @HiDeoo! - Adds a new navigation option to the blog configuration to control the type of navigation links to the blog to display on a page.

    The current behavior (header-end) to add a link to the blog before the theme switcher in the header on large viewports and a link to the mobile menu sidebar for non-blog pages on smaller viewports remains unchanged. Two new behaviors are now available:

    • header-start — Adds a link to the blog after the site title or logo in the header on large viewports. On smaller viewports, a link to the blog is added to the mobile menu sidebar for non-blog pages.
    • none — Does not add any links to the blog and it is up to the user to add links to the blog wherever they want.

Patch Changes

  • #139 6ed1559 Thanks @HiDeoo! - Fixes an inconsistency in blog post ordering for posts with the same date.

    Blog posts are now consistently ordered by their date in descending order, and then by their title in ascending order if the dates are identical.

0.22.0

Minor Changes

  • #144 93a5d70 Thanks @HiDeoo! - Adds support for defining excerpts using excerpt delimiters in blog posts. Any content above an excerpt delimiter will be used as the excerpt of a blog post.

    To learn more about excerpts, check the new “Excerpts” guide.

0.23.0

Minor Changes

  • #147 23f3f67 Thanks @HiDeoo! - Uses Starlight’s built-in support for internationalization powered by i18next to render blog post creation and update dates.

    This change allows for more flexibility in formatting and translating these dates, including the ability to use different formats for different locales.

    The starlightBlog.post.date string has been added to the list of UI strings provided by the plugin and the existing starlightBlog.post.lastUpdate string has been updated.

0.23.1

Patch Changes

0.23.2

Patch Changes

0.24.0 Latest

Minor Changes

  • #162 bc995dc Thanks @HiDeoo! - Exposes a list of all the authors in the blog data object accessible on Starlight pages using Astro.locals.starlightBlog.authors. This can be useful for example to create a widget that lists all the authors of your blog on your homepage.

    See the “Blog Data” guide for more information.

  • #160 f91a48c Thanks @HiDeoo! - Adds support for remote cover images in blog posts.

  • #155 e5746c1 Thanks @HiDeoo! - Adds support for metrics that can be displayed alongside blog posts, such as an estimated reading time or a word count.

    To learn more about metrics, check the new “Metrics” guide.