UNPKG

starlight-blog

Version:

Starlight plugin to add a blog to your documentation.

211 lines (108 loc) 15.6 kB
# starlight-blog ## 0.26.1 ### Patch Changes - [#202](https://github.com/HiDeoo/starlight-blog/pull/202) [`99e3282`](https://github.com/HiDeoo/starlight-blog/commit/99e328203cb0c1221e398e5cbf32db1747b12bc3) Thanks [@julien-deramond](https://github.com/julien-deramond)! - Fixes a regression in version `0.26.0` preventing to use `Infinity` as a value for the `postCount` and `recentPostCount` configuration options. ## 0.26.0 ### Minor Changes - [#199](https://github.com/HiDeoo/starlight-blog/pull/199) [`3c6cf12`](https://github.com/HiDeoo/starlight-blog/commit/3c6cf1209335c295921fbf283de26d20d9a6bae4) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds support for Astro v6, drops support for Astro v5. ⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now `0.38.0`. Please follow the [upgrade guide](https://github.com/withastro/starlight/releases/tag/%40astrojs%2Fstarlight%400.38.0) to update your project. - [#201](https://github.com/HiDeoo/starlight-blog/pull/201) [`a3cddb7`](https://github.com/HiDeoo/starlight-blog/commit/a3cddb7381a6029af430fac9351c39488b6e96ff) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds a new `rss` configuration option to disable the automatic generation of an RSS feed for the blog when the Astro `site` option is set. ## 0.25.3 ### Patch Changes - [#194](https://github.com/HiDeoo/starlight-blog/pull/194) [`d8721b8`](https://github.com/HiDeoo/starlight-blog/commit/d8721b8a917ab13fdfab63427f3dfc2137d4c406) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes a memory leak issue for blog posts with an excerpt due to a third-party dependency. ## 0.25.2 ### Patch Changes - [#186](https://github.com/HiDeoo/starlight-blog/pull/186) [`1bdbaa4`](https://github.com/HiDeoo/starlight-blog/commit/1bdbaa473101a2f0ff914fdb606553ee2626c4c1) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes a potential issue where author and tag names containing special characters could be improperly escaped in some UI strings. ## 0.25.1 ### Patch Changes - [#183](https://github.com/HiDeoo/starlight-blog/pull/183) [`d491d87`](https://github.com/HiDeoo/starlight-blog/commit/d491d87f64be60103826cdf200e255798dc53445) Thanks [@rksvc](https://github.com/rksvc)! - Removes Expressive Code line numbers in RSS feed. ## 0.25.0 ### Minor Changes - [#181](https://github.com/HiDeoo/starlight-blog/pull/181) [`5393110`](https://github.com/HiDeoo/starlight-blog/commit/53931103074eae1cc595f7b8f1cbcc477a0704a4) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds Astro’s built-in optimized asset support for local author profile pictures. ## 0.24.3 ### Patch Changes - [#178](https://github.com/HiDeoo/starlight-blog/pull/178) [`b2d4c4d`](https://github.com/HiDeoo/starlight-blog/commit/b2d4c4db486e63160ea9ed303831024c48d8ec1b) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Setups trusted publishing using OpenID Connect (OIDC) authentication — no code changes. ## 0.24.2 ### Patch Changes - [#175](https://github.com/HiDeoo/starlight-blog/pull/175) [`d624bf0`](https://github.com/HiDeoo/starlight-blog/commit/d624bf0ece2492c9f79b47cf7994c06638d94e8b) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes a potential issue where RSS content might be truncated in some cases. - [#175](https://github.com/HiDeoo/starlight-blog/pull/175) [`d624bf0`](https://github.com/HiDeoo/starlight-blog/commit/d624bf0ece2492c9f79b47cf7994c06638d94e8b) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes a potential issue where metrics might not be calculated correctly in some cases. ## 0.24.1 ### Patch Changes - [#169](https://github.com/HiDeoo/starlight-blog/pull/169) [`0e3ede8`](https://github.com/HiDeoo/starlight-blog/commit/0e3ede848fedfeebaabf40f4da967fcd6d0d2c33) Thanks [@Hofer-Julian](https://github.com/Hofer-Julian)! - Removes anchor links for headings in RSS feed. ## 0.24.0 ### Minor Changes - [#162](https://github.com/HiDeoo/starlight-blog/pull/162) [`bc995dc`](https://github.com/HiDeoo/starlight-blog/commit/bc995dce6ad26075316ee3240c6933bd00ffb090) Thanks [@HiDeoo](https://github.com/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](https://starlight-blog-docs.vercel.app/guides/blog-data/) for more information. - [#160](https://github.com/HiDeoo/starlight-blog/pull/160) [`f91a48c`](https://github.com/HiDeoo/starlight-blog/commit/f91a48c9d5527dcc54f0374e511fedd9bab95515) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds support for [remote](https://docs.astro.build/en/guides/images/#remote-images) [cover images](https://starlight-blog-docs.vercel.app/guides/frontmatter/#cover) in blog posts. - [#155](https://github.com/HiDeoo/starlight-blog/pull/155) [`e5746c1`](https://github.com/HiDeoo/starlight-blog/commit/e5746c19e8d350e0fc7e759de221fa6948100875) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds support for [metrics](https://starlight-blog-docs.vercel.app/configuration/#metrics-configuration) 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](https://starlight-blog-docs.vercel.app/guides/metrics/). ## 0.23.2 ### Patch Changes - [#153](https://github.com/HiDeoo/starlight-blog/pull/153) [`e288d9b`](https://github.com/HiDeoo/starlight-blog/commit/e288d9b3aa18652d8de3afda6622df6099e9192e) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes an issue with an invalid import specifier. ## 0.23.1 ### Patch Changes - [#150](https://github.com/HiDeoo/starlight-blog/pull/150) [`27cb85c`](https://github.com/HiDeoo/starlight-blog/commit/27cb85c13eac94d8cf9f65371a73fee2f23a7251) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes invalid labels for the prev/next links in the blog post list pages when using the [`prevNextLinksOrder` plugin option](https://starlight-blog-docs.vercel.app/configuration/#prevnextlinksorder) set to `chronological`. ## 0.23.0 ### Minor Changes - [#147](https://github.com/HiDeoo/starlight-blog/pull/147) [`23f3f67`](https://github.com/HiDeoo/starlight-blog/commit/23f3f673a1e60a039a05ef16dea7a2b11ca4a85e) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Uses [Starlight’s built-in support for internationalization](https://starlight.astro.build/guides/i18n/#using-ui-translations) powered by [i18next](https://www.i18next.com/) 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.22.0 ### Minor Changes - [#144](https://github.com/HiDeoo/starlight-blog/pull/144) [`93a5d70`](https://github.com/HiDeoo/starlight-blog/commit/93a5d70e06524f2eefe46ad3d3e4a9390cb646cf) Thanks [@HiDeoo](https://github.com/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](https://starlight-blog-docs.vercel.app/guides/excerpts/). ## 0.21.0 ### Minor Changes - [#139](https://github.com/HiDeoo/starlight-blog/pull/139) [`6ed1559`](https://github.com/HiDeoo/starlight-blog/commit/6ed15599bf075feeac4165e57d56b86967d72ad2) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Displays cover images for blog posts in pages that list blog posts such as the blog index page. - [#139](https://github.com/HiDeoo/starlight-blog/pull/139) [`6ed1559`](https://github.com/HiDeoo/starlight-blog/commit/6ed15599bf075feeac4165e57d56b86967d72ad2) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds a new [`navigation`](https://starlight-blog-docs.vercel.app/configuration/#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](https://github.com/HiDeoo/starlight-blog/pull/139) [`6ed1559`](https://github.com/HiDeoo/starlight-blog/commit/6ed15599bf075feeac4165e57d56b86967d72ad2) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes an inconsistency in blog post ordering for posts with the same date. Blog posts are now consistently ordered by their [`date`](https://starlight-blog-docs.vercel.app/guides/frontmatter/#date-required) in descending order, and then by their [`title`](https://starlight-blog-docs.vercel.app/guides/frontmatter/#title-required) in ascending order if the dates are identical. ## 0.20.0 ### Minor Changes - [#131](https://github.com/HiDeoo/starlight-blog/pull/131) [`32d0fdd`](https://github.com/HiDeoo/starlight-blog/commit/32d0fddf2ee01410e9c830de37209648f35de99d) Thanks [@HiDeoo](https://github.com/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: ```sh npx @astrojs/upgrade ``` ## 0.19.0 ### Minor Changes - [#128](https://github.com/HiDeoo/starlight-blog/pull/128) [`047cc90`](https://github.com/HiDeoo/starlight-blog/commit/047cc9050452779a0faf0319ecfadd24510617fb) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Exposes the [cover image](https://starlight-blog-docs.vercel.app/guides/blog-data/#cover) and [Astro content collection entry](https://starlight-blog-docs.vercel.app/guides/blog-dat/#entry) of blog posts in the blog data object accessible on Starlight pages. See the [“Blog Data” guide](https://starlight-blog-docs.vercel.app/guides/blog-data/) for more information. ## 0.18.0 ### Minor Changes - [#122](https://github.com/HiDeoo/starlight-blog/pull/122) [`75dee60`](https://github.com/HiDeoo/starlight-blog/commit/75dee601d9914a57269ba942b0332db04658ebdc) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Respects Starlight convention to generate URLs with a trailing slash when using the [`trailingSlash: 'ignore'`](https://docs.astro.build/en/reference/configuration-reference/#trailingslash) Astro configuration option (the default) as many common hosting providers redirect to URLs with a trailing slash by default. ## 0.17.3 ### Patch Changes - [#120](https://github.com/HiDeoo/starlight-blog/pull/120) [`24172db`](https://github.com/HiDeoo/starlight-blog/commit/24172dbe1b36442f982b86a5d3588749eb906658) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes a potential build issue for blogs with more than 20 posts also generating an RSS feed. ## 0.17.2 ### Patch Changes - [#115](https://github.com/HiDeoo/starlight-blog/pull/115) [`90da130`](https://github.com/HiDeoo/starlight-blog/commit/90da130940fc3b918f66a7cb0c4a6b1d1ef2a033) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Improves build performance for large sites by adding a caching layer to blog entries and data. ## 0.17.1 ### Patch Changes - [#113](https://github.com/HiDeoo/starlight-blog/pull/113) [`b6f7122`](https://github.com/HiDeoo/starlight-blog/commit/b6f7122206a11eb737a614cf2a6daf119531e6db) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes an issue where aside icons were not removed from RSS content. ## 0.17.0 ### Minor Changes - [#111](https://github.com/HiDeoo/starlight-blog/pull/111) [`144e6b2`](https://github.com/HiDeoo/starlight-blog/commit/144e6b2cad8ff011806f9b8d5bb7f609f7e8fc13) Thanks [@HiDeoo](https://github.com/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: ```sh npx @astrojs/upgrade ``` - [#111](https://github.com/HiDeoo/starlight-blog/pull/111) [`144e6b2`](https://github.com/HiDeoo/starlight-blog/commit/144e6b2cad8ff011806f9b8d5bb7f609f7e8fc13) Thanks [@HiDeoo](https://github.com/HiDeoo)! - ⚠️ **BREAKING CHANGE:** The Starlight Blog plugin no longer [overrides](https://starlight.astro.build/guides/overriding-components/) the [`<Sidebar>` component](https://starlight.astro.build/reference/overrides/#sidebar). If you were manually rendering `starlight-blog/overrides/Sidebar.astro` in a custom override, you can now remove it. - [#111](https://github.com/HiDeoo/starlight-blog/pull/111) [`144e6b2`](https://github.com/HiDeoo/starlight-blog/commit/144e6b2cad8ff011806f9b8d5bb7f609f7e8fc13) Thanks [@HiDeoo](https://github.com/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](https://starlight-blog-docs.vercel.app/guides/blog-data/) for more information. - [#111](https://github.com/HiDeoo/starlight-blog/pull/111) [`144e6b2`](https://github.com/HiDeoo/starlight-blog/commit/144e6b2cad8ff011806f9b8d5bb7f609f7e8fc13) Thanks [@HiDeoo](https://github.com/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.16.1 ### Patch Changes - [#105](https://github.com/HiDeoo/starlight-blog/pull/105) [`4ce050c`](https://github.com/HiDeoo/starlight-blog/commit/4ce050c9e6317d2cb3b7329e84aa9b0a5aa02cb5) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds support for passing [`Infinity`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Infinity) to the [`postCount`](https://starlight-blog-docs.vercel.app/configuration#postcount) and [`recentPostCount`](https://starlight-blog-docs.vercel.app/configuration#recentpostcount) configuration options. ## 0.16.0 ### Minor Changes - [#100](https://github.com/HiDeoo/starlight-blog/pull/100) [`679e509`](https://github.com/HiDeoo/starlight-blog/commit/679e50998bad26034735c99302de5645dd87bf6e) Thanks [@HiDeoo](https://github.com/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](https://github.com/withastro/starlight/releases/tag/%40astrojs/starlight%400.30.0) to update your project. Note that the [`legacy.collections` flag](https://docs.astro.build/en/reference/legacy-flags/#collections) 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](https://github.com/withastro/astro/issues/12669) 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.