diff --git a/.changeset/green-suns-drive.md b/.changeset/green-suns-drive.md deleted file mode 100644 index 29f7dd1522c..00000000000 --- a/.changeset/green-suns-drive.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -"@astrojs/starlight": minor ---- - -Adds support for Astro v5, drops support for Astro v4. - -#### Upgrade Astro and dependencies - -⚠️ **BREAKING CHANGE:** Astro v4 is no longer supported. Make sure you [update Astro](https://docs.astro.build/en/guides/upgrade-to/v5/) and any other official integrations at the same time as updating Starlight: - -```sh -npx @astrojs/upgrade -``` - -_Community Starlight plugins and Astro integrations may also need to be manually updated to work with Astro v5. If you encounter any issues, please reach out to the plugin or integration author to see if it is a known issue or if an updated version is being worked on._ - -#### Update your collections - -⚠️ **BREAKING CHANGE:** Starlight's internal [content collections](https://docs.astro.build/en/guides/content-collections/), which organize, validate, and render your content, have been updated to use Astro's new Content Layer API and require configuration changes in your project. - -1. **Move the content config file.** This file no longer lives within the `src/content/config.ts` folder and should now exist at `src/content.config.ts`. - - -1. **Edit the collection definition(s).** To update the `docs` collection, a `loader` is now required: - - ```diff - // src/content.config.ts - import { defineCollection } from "astro:content"; - +import { docsLoader } from "@astrojs/starlight/loaders"; - import { docsSchema } from "@astrojs/starlight/schema"; - - export const collections = { - - docs: defineCollection({ schema: docsSchema() }), - + docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }), - }; - ``` - - If you are using the [`i18n` collection](https://starlight.astro.build/guides/i18n/#translate-starlights-ui) to provide translations for additional languages you support or override our default labels, you will need to update the collection definition in a similar way and remove the collection `type` which is no longer available: - - ```diff - // src/content.config.ts - import { defineCollection } from "astro:content"; - +import { docsLoader, i18nLoader } from "@astrojs/starlight/loaders"; - import { docsSchema, i18nSchema } from "@astrojs/starlight/schema"; - - export const collections = { - - docs: defineCollection({ schema: docsSchema() }), - + docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }), - - i18n: defineCollection({ type: 'data', schema: i18nSchema() }), - + i18n: defineCollection({ loader: i18nLoader(), schema: i18nSchema() }), - }; - ``` - -1. **Update other collections.** To update any other collections you may have, follow the [“Updating existing collections”](https://docs.astro.build/en/guides/upgrade-to/v5/#updating-existing-collections) section in the Astro 5 upgrade guide. - -If you are unable to make any changes to your collections at this time, including Starlight's default `docs` and `i18n` collections, you can enable the [`legacy.collections` flag](https://docs.astro.build/en/reference/legacy-flags/) to upgrade to v5 without updating your collections. This legacy flag exists to provide temporary backwards compatibility, and will allow you to keep your collections in their current state until the legacy flag is no longer supported. diff --git a/.changeset/loud-cycles-arrive.md b/.changeset/loud-cycles-arrive.md deleted file mode 100644 index d281317d10c..00000000000 --- a/.changeset/loud-cycles-arrive.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@astrojs/starlight": patch ---- - -Adds Catalan UI translations diff --git a/.changeset/polite-snails-sip.md b/.changeset/polite-snails-sip.md deleted file mode 100644 index 588ca3251c7..00000000000 --- a/.changeset/polite-snails-sip.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -'@astrojs/starlight-docsearch': minor -'@astrojs/starlight-tailwind': major -'@astrojs/starlight-markdoc': minor ---- - -⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now 0.30.0 - -Please use the `@astrojs/upgrade` command to upgrade your project: - -```sh -npx @astrojs/upgrade -``` diff --git a/.changeset/sweet-poems-smoke.md b/.changeset/sweet-poems-smoke.md deleted file mode 100644 index a4835124ca7..00000000000 --- a/.changeset/sweet-poems-smoke.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -'@astrojs/starlight-docsearch': patch -'@astrojs/starlight': patch -'@astrojs/starlight-tailwind': patch -'@astrojs/starlight-markdoc': patch ---- - -Publishes provenance containing verifiable data to link a package back to its source repository and the specific build instructions used to publish it. diff --git a/.changeset/wet-frogs-act.md b/.changeset/wet-frogs-act.md deleted file mode 100644 index b98ac55c7ec..00000000000 --- a/.changeset/wet-frogs-act.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@astrojs/starlight": patch ---- - -Adds Spanish UI translations for the Pagefind search modal diff --git a/examples/basics/package.json b/examples/basics/package.json index d3c6bea0e0d..8662fc45d1d 100644 --- a/examples/basics/package.json +++ b/examples/basics/package.json @@ -11,7 +11,7 @@ "astro": "astro" }, "dependencies": { - "@astrojs/starlight": "^0.29.3", + "@astrojs/starlight": "^0.30.0", "astro": "^5.0.2", "sharp": "^0.32.5" } diff --git a/examples/markdoc/package.json b/examples/markdoc/package.json index 550b5669290..9d4bcbac3f6 100644 --- a/examples/markdoc/package.json +++ b/examples/markdoc/package.json @@ -12,8 +12,8 @@ }, "dependencies": { "@astrojs/markdoc": "^0.12.1", - "@astrojs/starlight": "^0.29.3", - "@astrojs/starlight-markdoc": "^0.1.0", + "@astrojs/starlight": "^0.30.0", + "@astrojs/starlight-markdoc": "^0.2.0", "astro": "^5.0.2", "sharp": "^0.32.5" } diff --git a/examples/tailwind/package.json b/examples/tailwind/package.json index 9918cc4fb65..b8ab6c9b8e7 100644 --- a/examples/tailwind/package.json +++ b/examples/tailwind/package.json @@ -11,8 +11,8 @@ "astro": "astro" }, "dependencies": { - "@astrojs/starlight": "^0.29.3", - "@astrojs/starlight-tailwind": "^2.0.3", + "@astrojs/starlight": "^0.30.0", + "@astrojs/starlight-tailwind": "^3.0.0", "@astrojs/tailwind": "^5.1.3", "astro": "^5.0.2", "sharp": "^0.32.5", diff --git a/packages/docsearch/CHANGELOG.md b/packages/docsearch/CHANGELOG.md index 060c9786bf9..ac810fb4502 100644 --- a/packages/docsearch/CHANGELOG.md +++ b/packages/docsearch/CHANGELOG.md @@ -1,5 +1,21 @@ # @astrojs/starlight-docsearch +## 0.4.0 + +### Minor Changes + +- [#2612](https://github.com/withastro/starlight/pull/2612) [`8d5a4e8`](https://github.com/withastro/starlight/commit/8d5a4e8000d9e3a4bb9ca8178767cf3d8bc48773) Thanks [@HiDeoo](https://github.com/HiDeoo)! - ⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now 0.30.0 + + Please use the `@astrojs/upgrade` command to upgrade your project: + + ```sh + npx @astrojs/upgrade + ``` + +### Patch Changes + +- [#2664](https://github.com/withastro/starlight/pull/2664) [`62ff007`](https://github.com/withastro/starlight/commit/62ff0074d9a3f82e46f5c62db85c04d87ff5e931) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Publishes provenance containing verifiable data to link a package back to its source repository and the specific build instructions used to publish it. + ## 0.3.0 ### Minor Changes diff --git a/packages/docsearch/package.json b/packages/docsearch/package.json index ca909d193e7..47072792128 100644 --- a/packages/docsearch/package.json +++ b/packages/docsearch/package.json @@ -1,6 +1,6 @@ { "name": "@astrojs/starlight-docsearch", - "version": "0.3.0", + "version": "0.4.0", "description": "Algolia DocSearch plugin for the Starlight documentation theme for Astro", "author": "Chris Swithinbank ", "license": "MIT", diff --git a/packages/markdoc/CHANGELOG.md b/packages/markdoc/CHANGELOG.md index 433575df48d..caea551826b 100644 --- a/packages/markdoc/CHANGELOG.md +++ b/packages/markdoc/CHANGELOG.md @@ -1,5 +1,21 @@ # @astrojs/starlight-markdoc +## 0.2.0 + +### Minor Changes + +- [#2612](https://github.com/withastro/starlight/pull/2612) [`8d5a4e8`](https://github.com/withastro/starlight/commit/8d5a4e8000d9e3a4bb9ca8178767cf3d8bc48773) Thanks [@HiDeoo](https://github.com/HiDeoo)! - ⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now 0.30.0 + + Please use the `@astrojs/upgrade` command to upgrade your project: + + ```sh + npx @astrojs/upgrade + ``` + +### Patch Changes + +- [#2664](https://github.com/withastro/starlight/pull/2664) [`62ff007`](https://github.com/withastro/starlight/commit/62ff0074d9a3f82e46f5c62db85c04d87ff5e931) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Publishes provenance containing verifiable data to link a package back to its source repository and the specific build instructions used to publish it. + ## 0.1.0 ### Minor Changes diff --git a/packages/markdoc/package.json b/packages/markdoc/package.json index 4a8f55a9c5f..96947a418a4 100644 --- a/packages/markdoc/package.json +++ b/packages/markdoc/package.json @@ -1,6 +1,6 @@ { "name": "@astrojs/starlight-markdoc", - "version": "0.1.0", + "version": "0.2.0", "description": "Markdoc preset 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 95322543cc3..53b50c34c4e 100644 --- a/packages/starlight/CHANGELOG.md +++ b/packages/starlight/CHANGELOG.md @@ -1,5 +1,68 @@ # @astrojs/starlight +## 0.30.0 + +### Minor Changes + +- [#2612](https://github.com/withastro/starlight/pull/2612) [`8d5a4e8`](https://github.com/withastro/starlight/commit/8d5a4e8000d9e3a4bb9ca8178767cf3d8bc48773) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds support for Astro v5, drops support for Astro v4. + + #### Upgrade Astro and dependencies + + ⚠️ **BREAKING CHANGE:** Astro v4 is no longer supported. Make sure you [update Astro](https://docs.astro.build/en/guides/upgrade-to/v5/) and any other official integrations at the same time as updating Starlight: + + ```sh + npx @astrojs/upgrade + ``` + + _Community Starlight plugins and Astro integrations may also need to be manually updated to work with Astro v5. If you encounter any issues, please reach out to the plugin or integration author to see if it is a known issue or if an updated version is being worked on._ + + #### Update your collections + + ⚠️ **BREAKING CHANGE:** Starlight's internal [content collections](https://docs.astro.build/en/guides/content-collections/), which organize, validate, and render your content, have been updated to use Astro's new Content Layer API and require configuration changes in your project. + + 1. **Move the content config file.** This file no longer lives within the `src/content/config.ts` folder and should now exist at `src/content.config.ts`. + 1. **Edit the collection definition(s).** To update the `docs` collection, a `loader` is now required: + + ```diff + // src/content.config.ts + import { defineCollection } from "astro:content"; + +import { docsLoader } from "@astrojs/starlight/loaders"; + import { docsSchema } from "@astrojs/starlight/schema"; + + export const collections = { + - docs: defineCollection({ schema: docsSchema() }), + + docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }), + }; + ``` + + If you are using the [`i18n` collection](https://starlight.astro.build/guides/i18n/#translate-starlights-ui) to provide translations for additional languages you support or override our default labels, you will need to update the collection definition in a similar way and remove the collection `type` which is no longer available: + + ```diff + // src/content.config.ts + import { defineCollection } from "astro:content"; + +import { docsLoader, i18nLoader } from "@astrojs/starlight/loaders"; + import { docsSchema, i18nSchema } from "@astrojs/starlight/schema"; + + export const collections = { + - docs: defineCollection({ schema: docsSchema() }), + + docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }), + - i18n: defineCollection({ type: 'data', schema: i18nSchema() }), + + i18n: defineCollection({ loader: i18nLoader(), schema: i18nSchema() }), + }; + ``` + + 1. **Update other collections.** To update any other collections you may have, follow the [“Updating existing collections”](https://docs.astro.build/en/guides/upgrade-to/v5/#updating-existing-collections) section in the Astro 5 upgrade guide. + + If you are unable to make any changes to your collections at this time, including Starlight's default `docs` and `i18n` collections, you can enable the [`legacy.collections` flag](https://docs.astro.build/en/reference/legacy-flags/) to upgrade to v5 without updating your collections. This legacy flag exists to provide temporary backwards compatibility, and will allow you to keep your collections in their current state until the legacy flag is no longer supported. + +### Patch Changes + +- [#2669](https://github.com/withastro/starlight/pull/2669) [`310df7d`](https://github.com/withastro/starlight/commit/310df7d6b01f5c4a56540bdba9243fb60dace323) Thanks [@aaronperezaguilera](https://github.com/aaronperezaguilera)! - Adds Catalan UI translations + +- [#2664](https://github.com/withastro/starlight/pull/2664) [`62ff007`](https://github.com/withastro/starlight/commit/62ff0074d9a3f82e46f5c62db85c04d87ff5e931) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Publishes provenance containing verifiable data to link a package back to its source repository and the specific build instructions used to publish it. + +- [#2670](https://github.com/withastro/starlight/pull/2670) [`0223b42`](https://github.com/withastro/starlight/commit/0223b425249f8d1fa468e367c632467276c9c208) Thanks [@aaronperezaguilera](https://github.com/aaronperezaguilera)! - Adds Spanish UI translations for the Pagefind search modal + ## 0.29.3 ### Patch Changes diff --git a/packages/starlight/package.json b/packages/starlight/package.json index f1ba4041d93..0a00a079648 100644 --- a/packages/starlight/package.json +++ b/packages/starlight/package.json @@ -1,6 +1,6 @@ { "name": "@astrojs/starlight", - "version": "0.29.3", + "version": "0.30.0", "description": "Build beautiful, high-performance documentation websites with Astro", "scripts": { "test": "vitest", diff --git a/packages/tailwind/CHANGELOG.md b/packages/tailwind/CHANGELOG.md index 6fede0fe1fe..8e6f64c9e52 100644 --- a/packages/tailwind/CHANGELOG.md +++ b/packages/tailwind/CHANGELOG.md @@ -1,5 +1,21 @@ # @astrojs/starlight-tailwind +## 3.0.0 + +### Major Changes + +- [#2612](https://github.com/withastro/starlight/pull/2612) [`8d5a4e8`](https://github.com/withastro/starlight/commit/8d5a4e8000d9e3a4bb9ca8178767cf3d8bc48773) Thanks [@HiDeoo](https://github.com/HiDeoo)! - ⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now 0.30.0 + + Please use the `@astrojs/upgrade` command to upgrade your project: + + ```sh + npx @astrojs/upgrade + ``` + +### Patch Changes + +- [#2664](https://github.com/withastro/starlight/pull/2664) [`62ff007`](https://github.com/withastro/starlight/commit/62ff0074d9a3f82e46f5c62db85c04d87ff5e931) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Publishes provenance containing verifiable data to link a package back to its source repository and the specific build instructions used to publish it. + ## 2.0.3 ### Patch Changes diff --git a/packages/tailwind/package.json b/packages/tailwind/package.json index bf6334537c6..3819e105949 100644 --- a/packages/tailwind/package.json +++ b/packages/tailwind/package.json @@ -1,6 +1,6 @@ { "name": "@astrojs/starlight-tailwind", - "version": "2.0.3", + "version": "3.0.0", "description": "Tailwind CSS plugin for the Starlight documentation theme for Astro", "author": "Chris Swithinbank ", "license": "MIT", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 6fda502cfcd..f775c799823 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -81,7 +81,7 @@ importers: examples/basics: dependencies: '@astrojs/starlight': - specifier: ^0.29.3 + specifier: ^0.30.0 version: link:../../packages/starlight astro: specifier: ^5.0.2 @@ -96,10 +96,10 @@ importers: specifier: ^0.12.1 version: 0.12.1(astro@5.0.2) '@astrojs/starlight': - specifier: ^0.29.3 + specifier: ^0.30.0 version: link:../../packages/starlight '@astrojs/starlight-markdoc': - specifier: ^0.1.0 + specifier: ^0.2.0 version: link:../../packages/markdoc astro: specifier: ^5.0.2 @@ -111,10 +111,10 @@ importers: examples/tailwind: dependencies: '@astrojs/starlight': - specifier: ^0.29.3 + specifier: ^0.30.0 version: link:../../packages/starlight '@astrojs/starlight-tailwind': - specifier: ^2.0.3 + specifier: ^3.0.0 version: link:../../packages/tailwind '@astrojs/tailwind': specifier: ^5.1.3