diff --git a/.changeset/cool-experts-sort.md b/.changeset/cool-experts-sort.md deleted file mode 100644 index 6de9fd8c02f..00000000000 --- a/.changeset/cool-experts-sort.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -Overhauls the built-in localization system which is now powered by the [`i18next`](https://www.i18next.com/) library and available to use anywhere in your documentation website. - -See the [“Using UI translations”](https://starlight.astro.build/guides/i18n/#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()`](https://starlight.astro.build/reference/plugins/#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()`](https://starlight.astro.build/guides/i18n/#using-ui-translations) helper instead. - -```astro ---- -import type { Props } from '@astrojs/starlight/props'; -// The `search.label` UI label for this page’s language: -const searchLabel = Astro.locals.t('search.label'); ---- -``` diff --git a/.changeset/eighty-beds-attack.md b/.changeset/eighty-beds-attack.md deleted file mode 100644 index 000fa3e945c..00000000000 --- a/.changeset/eighty-beds-attack.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -'@astrojs/starlight-docsearch': minor ---- - -⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now 0.28.0 - -Please use the `@astrojs/upgrade` command to upgrade your project: - -```sh -npx @astrojs/upgrade -``` diff --git a/.changeset/gold-coats-destroy.md b/.changeset/gold-coats-destroy.md deleted file mode 100644 index 416391d637d..00000000000 --- a/.changeset/gold-coats-destroy.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@astrojs/starlight": patch ---- - -Fixes restoration of remark directives for nodes with custom data attached. diff --git a/.changeset/slow-flowers-sort.md b/.changeset/slow-flowers-sort.md deleted file mode 100644 index c93a151fb03..00000000000 --- a/.changeset/slow-flowers-sort.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -Adds support for translating sidebar badges. diff --git a/.changeset/thirty-dodos-drop.md b/.changeset/thirty-dodos-drop.md deleted file mode 100644 index 4fef44db65a..00000000000 --- a/.changeset/thirty-dodos-drop.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -⚠️ **BREAKING CHANGE:** The minimum supported version of Astro is now 4.14.0 - -Please update Astro and Starlight together: - -```sh -npx @astrojs/upgrade -``` diff --git a/examples/basics/package.json b/examples/basics/package.json index 98bb457a9a5..53f3ccafa70 100644 --- a/examples/basics/package.json +++ b/examples/basics/package.json @@ -11,7 +11,7 @@ "astro": "astro" }, "dependencies": { - "@astrojs/starlight": "^0.27.1", + "@astrojs/starlight": "^0.28.0", "astro": "^4.15.3", "sharp": "^0.32.5" } diff --git a/examples/markdoc/package.json b/examples/markdoc/package.json index df72c12d222..e4d2f0b7f7c 100644 --- a/examples/markdoc/package.json +++ b/examples/markdoc/package.json @@ -12,7 +12,7 @@ }, "dependencies": { "@astrojs/markdoc": "^0.11.4", - "@astrojs/starlight": "^0.27.1", + "@astrojs/starlight": "^0.28.0", "@astrojs/starlight-markdoc": "^0.1.0", "astro": "^4.15.3", "sharp": "^0.32.5" diff --git a/examples/tailwind/package.json b/examples/tailwind/package.json index 16b0ba64f14..0b7adafc209 100644 --- a/examples/tailwind/package.json +++ b/examples/tailwind/package.json @@ -11,7 +11,7 @@ "astro": "astro" }, "dependencies": { - "@astrojs/starlight": "^0.27.1", + "@astrojs/starlight": "^0.28.0", "@astrojs/starlight-tailwind": "^2.0.3", "@astrojs/tailwind": "^5.1.0", "astro": "^4.15.3", diff --git a/packages/docsearch/CHANGELOG.md b/packages/docsearch/CHANGELOG.md index c0681227ec5..cc3d7a72739 100644 --- a/packages/docsearch/CHANGELOG.md +++ b/packages/docsearch/CHANGELOG.md @@ -1,5 +1,17 @@ # @astrojs/starlight-docsearch +## 0.2.0 + +### Minor Changes + +- [#1923](https://github.com/withastro/starlight/pull/1923) [`5269aad`](https://github.com/withastro/starlight/commit/5269aad928773ae08b35ba8e19c0f2832d0d2c89) Thanks [@HiDeoo](https://github.com/HiDeoo)! - ⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now 0.28.0 + + Please use the `@astrojs/upgrade` command to upgrade your project: + + ```sh + npx @astrojs/upgrade + ``` + ## 0.1.1 ### Patch Changes diff --git a/packages/docsearch/package.json b/packages/docsearch/package.json index 8826ac25aa6..55076a142ed 100644 --- a/packages/docsearch/package.json +++ b/packages/docsearch/package.json @@ -1,6 +1,6 @@ { "name": "@astrojs/starlight-docsearch", - "version": "0.1.1", + "version": "0.2.0", "description": "Algolia DocSearch plugin for the Starlight documentation theme for Astro", "author": "Chris Swithinbank ", "license": "MIT", diff --git a/packages/starlight/CHANGELOG.md b/packages/starlight/CHANGELOG.md index fe584196aa2..3179f278e54 100644 --- a/packages/starlight/CHANGELOG.md +++ b/packages/starlight/CHANGELOG.md @@ -1,5 +1,39 @@ # @astrojs/starlight +## 0.28.0 + +### Minor Changes + +- [#1923](https://github.com/withastro/starlight/pull/1923) [`5269aad`](https://github.com/withastro/starlight/commit/5269aad928773ae08b35ba8e19c0f2832d0d2c89) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Overhauls the built-in localization system which is now powered by the [`i18next`](https://www.i18next.com/) library and available to use anywhere in your documentation website. + + See the [“Using UI translations”](https://starlight.astro.build/guides/i18n/#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()`](https://starlight.astro.build/reference/plugins/#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()`](https://starlight.astro.build/guides/i18n/#using-ui-translations) helper instead. + + ```astro + --- + 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](https://github.com/withastro/starlight/pull/2285) [`7286220`](https://github.com/withastro/starlight/commit/728622037602999ed67dedc2757ca5654236feb8) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds support for translating sidebar badges. + +- [#1923](https://github.com/withastro/starlight/pull/1923) [`5269aad`](https://github.com/withastro/starlight/commit/5269aad928773ae08b35ba8e19c0f2832d0d2c89) Thanks [@HiDeoo](https://github.com/HiDeoo)! - ⚠️ **BREAKING CHANGE:** The minimum supported version of Astro is now 4.14.0 + + Please update Astro and Starlight together: + + ```sh + npx @astrojs/upgrade + ``` + +### Patch Changes + +- [#2327](https://github.com/withastro/starlight/pull/2327) [`d7a295e`](https://github.com/withastro/starlight/commit/d7a295e5f63171c7eee9fc11333157d8c7e6c803) Thanks [@tritao](https://github.com/tritao)! - Fixes restoration of remark directives for nodes with custom data attached. + ## 0.27.1 ### Patch Changes diff --git a/packages/starlight/package.json b/packages/starlight/package.json index e154d8e6fe2..544db269a13 100644 --- a/packages/starlight/package.json +++ b/packages/starlight/package.json @@ -1,6 +1,6 @@ { "name": "@astrojs/starlight", - "version": "0.27.1", + "version": "0.28.0", "description": "Build beautiful, high-performance documentation websites with Astro", "scripts": { "test": "vitest", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 5233b638ede..97d19f221a5 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -73,7 +73,7 @@ importers: examples/basics: dependencies: '@astrojs/starlight': - specifier: ^0.27.1 + specifier: ^0.28.0 version: link:../../packages/starlight astro: specifier: ^4.15.3 @@ -88,7 +88,7 @@ importers: specifier: ^0.11.4 version: 0.11.4(astro@4.15.3) '@astrojs/starlight': - specifier: ^0.27.1 + specifier: ^0.28.0 version: link:../../packages/starlight '@astrojs/starlight-markdoc': specifier: ^0.1.0 @@ -103,7 +103,7 @@ importers: examples/tailwind: dependencies: '@astrojs/starlight': - specifier: ^0.27.1 + specifier: ^0.28.0 version: link:../../packages/starlight '@astrojs/starlight-tailwind': specifier: ^2.0.3