diff --git a/.changeset/agile-eyes-fold.md b/.changeset/agile-eyes-fold.md deleted file mode 100644 index 82669ab60f8..00000000000 --- a/.changeset/agile-eyes-fold.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -Adds support for Astro v6, drops support for Astro v5. - -#### Upgrade Astro and dependencies - -⚠️ **BREAKING CHANGE:** Astro v5 is no longer supported. Make sure you [update Astro](https://docs.astro.build/en/guides/upgrade-to/v6/) 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 v6. 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:** Drops support for content collections backwards compatibility. - -In Astro 5.x, projects could delay upgrading to the new Content Layer API introduced for content collections because of some existing automatic backwards compatibility that was not previously behind a flag. This meant that it was possible to upgrade from Astro 4 to Astro 5 without updating your content collections, even if you had not enabled the `legacy.collections` flag. Projects would continue to build, and no errors or warnings would be displayed. - -Astro v6.0 now removes this automatic legacy content collections support, along with the `legacy.collections` flag. - -If you experience content collections errors after updating to v6, [check your project for any removed legacy features](https://docs.astro.build/en/guides/upgrade-to/v6/#if-you-have) that may need updating to the Content Layer API. See [the Starlight v0.30.0 upgrade guide](https://github.com/withastro/starlight/blob/main/packages/starlight/CHANGELOG.md#0300) for detailed instructions on upgrading legacy collections to the new Content Layer API. - -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.collectionsBackwardsCompat` flag](https://docs.astro.build/en/reference/legacy-flags/#collectionsbackwardscompat) to upgrade to v6 without updating your collections. This temporary flag preserves some legacy v4 content collections features, and will allow you to keep your collections in their current state until the legacy flag is no longer supported. diff --git a/.changeset/beige-ties-scream.md b/.changeset/beige-ties-scream.md deleted file mode 100644 index 587b74de16a..00000000000 --- a/.changeset/beige-ties-scream.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -Fixes autocomplete for components exported from `@astrojs/starlight/components/*` - -**⚠️ Potentially breaking change:** This change moves some files used in Starlight’s component internals out of the `components/` directory. Direct use of these files was not and is not officially supported. If you previously imported `TableOfContents/starlight-toc.ts`, `TableOfContents/TableOfContentsList.astro`, `Icons.ts`, or `SidebarPersistState.ts`, please review your code when updating. diff --git a/.changeset/dry-bikes-beg.md b/.changeset/dry-bikes-beg.md deleted file mode 100644 index 80a93eced16..00000000000 --- a/.changeset/dry-bikes-beg.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -'@astrojs/starlight-markdoc': minor ---- - -⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now 0.38.0 - -Please use the `@astrojs/upgrade` command to upgrade your project: - -```sh -npx @astrojs/upgrade -``` diff --git a/.changeset/fuzzy-walls-jump.md b/.changeset/fuzzy-walls-jump.md deleted file mode 100644 index 22eb832b398..00000000000 --- a/.changeset/fuzzy-walls-jump.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -Improves Starlight’s default body font stack to better support languages such as Chinese, Japanese, and Korean on Windows. -For most users there should be no visible change. - -If you would prefer to keep the previous font stack, you can add the following custom CSS to your site: - -```css -:root { - --sl-font-system: - ui-sans-serif, system-ui, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, 'Noto Sans', sans-serif, - 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol', 'Noto Color Emoji'; -} -``` diff --git a/.changeset/hot-dryers-drop.md b/.changeset/hot-dryers-drop.md deleted file mode 100644 index dd321c8c410..00000000000 --- a/.changeset/hot-dryers-drop.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -'@astrojs/starlight-tailwind': major ---- - -⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now 0.38.0 - -Please use the `@astrojs/upgrade` command to upgrade your project: - -```sh -npx @astrojs/upgrade -``` diff --git a/.changeset/modern-hats-confess.md b/.changeset/modern-hats-confess.md deleted file mode 100644 index 27b169c1c91..00000000000 --- a/.changeset/modern-hats-confess.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -Makes hover styles consistent in Starlight’s navigation bar - -Previously, the social icon links and language/theme switchers in Starlight’s navigation bar, dimmed on hover. -After this change, they now increase in contrast on hover instead. -This matches hover behavior elsewhere, for example in the sidebar, table of contents, or search button. - -⚠️ **Potentially breaking change:** this is a subtle change to the hover style colors. -If you want to preserve the previous styling, you can add the following [custom CSS](https://starlight.astro.build/guides/css-and-tailwind/#custom-css-styles) to your site: - -```css -starlight-theme-select label, -starlight-lang-select label { - color: var(--sl-color-gray-1); - - &:hover { - color: var(--sl-color-white); - } -} - -.social-icons a:hover { - color: var(--sl-color-text-accent); - opacity: 0.66; -} -``` diff --git a/.changeset/spicy-moons-sell.md b/.changeset/spicy-moons-sell.md deleted file mode 100644 index a234d997761..00000000000 --- a/.changeset/spicy-moons-sell.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -'@astrojs/starlight-docsearch': minor ---- - -⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now 0.38.0 - -Please use the `@astrojs/upgrade` command to upgrade your project: - -```sh -npx @astrojs/upgrade -``` - diff --git a/examples/basics/package.json b/examples/basics/package.json index edf8e5f59ea..af0cd1f70fe 100644 --- a/examples/basics/package.json +++ b/examples/basics/package.json @@ -11,7 +11,7 @@ "astro": "astro" }, "dependencies": { - "@astrojs/starlight": "^0.37.7", + "@astrojs/starlight": "^0.38.0", "astro": "^6.0.1", "sharp": "^0.34.2" } diff --git a/examples/markdoc/package.json b/examples/markdoc/package.json index 7e310ce6f95..a6aa2cc2d1e 100644 --- a/examples/markdoc/package.json +++ b/examples/markdoc/package.json @@ -12,8 +12,8 @@ }, "dependencies": { "@astrojs/markdoc": "^1.0.0", - "@astrojs/starlight": "^0.37.7", - "@astrojs/starlight-markdoc": "^0.5.1", + "@astrojs/starlight": "^0.38.0", + "@astrojs/starlight-markdoc": "^0.6.0", "astro": "^6.0.1", "sharp": "^0.34.2" } diff --git a/examples/tailwind/package.json b/examples/tailwind/package.json index b6b222aea18..374fed214a5 100644 --- a/examples/tailwind/package.json +++ b/examples/tailwind/package.json @@ -11,8 +11,8 @@ "astro": "astro" }, "dependencies": { - "@astrojs/starlight": "^0.37.7", - "@astrojs/starlight-tailwind": "^4.0.2", + "@astrojs/starlight": "^0.38.0", + "@astrojs/starlight-tailwind": "^5.0.0", "@tailwindcss/vite": "^4.1.18", "astro": "^6.0.1", "sharp": "^0.34.2", diff --git a/packages/docsearch/CHANGELOG.md b/packages/docsearch/CHANGELOG.md index 6e006b168e1..91f166d71c7 100644 --- a/packages/docsearch/CHANGELOG.md +++ b/packages/docsearch/CHANGELOG.md @@ -1,5 +1,17 @@ # @astrojs/starlight-docsearch +## 0.7.0 + +### Minor Changes + +- [#3644](https://github.com/withastro/starlight/pull/3644) [`0d2e7ed`](https://github.com/withastro/starlight/commit/0d2e7ed74a604b028fcab0c81b4c35c0c9365343) Thanks [@HiDeoo](https://github.com/HiDeoo)! - ⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now 0.38.0 + + Please use the `@astrojs/upgrade` command to upgrade your project: + + ```sh + npx @astrojs/upgrade + ``` + ## 0.6.1 ### Patch Changes diff --git a/packages/docsearch/package.json b/packages/docsearch/package.json index 7dca3d079db..35b3e25fde2 100644 --- a/packages/docsearch/package.json +++ b/packages/docsearch/package.json @@ -1,6 +1,6 @@ { "name": "@astrojs/starlight-docsearch", - "version": "0.6.1", + "version": "0.7.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 d4d458b6681..191b50a6121 100644 --- a/packages/markdoc/CHANGELOG.md +++ b/packages/markdoc/CHANGELOG.md @@ -1,5 +1,17 @@ # @astrojs/starlight-markdoc +## 0.6.0 + +### Minor Changes + +- [#3644](https://github.com/withastro/starlight/pull/3644) [`0d2e7ed`](https://github.com/withastro/starlight/commit/0d2e7ed74a604b028fcab0c81b4c35c0c9365343) Thanks [@HiDeoo](https://github.com/HiDeoo)! - ⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now 0.38.0 + + Please use the `@astrojs/upgrade` command to upgrade your project: + + ```sh + npx @astrojs/upgrade + ``` + ## 0.5.1 ### Patch Changes diff --git a/packages/markdoc/package.json b/packages/markdoc/package.json index f26f8f6cab4..c8793ebab2b 100644 --- a/packages/markdoc/package.json +++ b/packages/markdoc/package.json @@ -1,6 +1,6 @@ { "name": "@astrojs/starlight-markdoc", - "version": "0.5.1", + "version": "0.6.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 0a830877d22..4decceaebbf 100644 --- a/packages/starlight/CHANGELOG.md +++ b/packages/starlight/CHANGELOG.md @@ -1,5 +1,75 @@ # @astrojs/starlight +## 0.38.0 + +### Minor Changes + +- [#3644](https://github.com/withastro/starlight/pull/3644) [`0d2e7ed`](https://github.com/withastro/starlight/commit/0d2e7ed74a604b028fcab0c81b4c35c0c9365343) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds support for Astro v6, drops support for Astro v5. + + #### Upgrade Astro and dependencies + + ⚠️ **BREAKING CHANGE:** Astro v5 is no longer supported. Make sure you [update Astro](https://docs.astro.build/en/guides/upgrade-to/v6/) 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 v6. 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:** Drops support for content collections backwards compatibility. + + In Astro 5.x, projects could delay upgrading to the new Content Layer API introduced for content collections because of some existing automatic backwards compatibility that was not previously behind a flag. This meant that it was possible to upgrade from Astro 4 to Astro 5 without updating your content collections, even if you had not enabled the `legacy.collections` flag. Projects would continue to build, and no errors or warnings would be displayed. + + Astro v6.0 now removes this automatic legacy content collections support, along with the `legacy.collections` flag. + + If you experience content collections errors after updating to v6, [check your project for any removed legacy features](https://docs.astro.build/en/guides/upgrade-to/v6/#if-you-have) that may need updating to the Content Layer API. See [the Starlight v0.30.0 upgrade guide](https://github.com/withastro/starlight/blob/main/packages/starlight/CHANGELOG.md#0300) for detailed instructions on upgrading legacy collections to the new Content Layer API. + + 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.collectionsBackwardsCompat` flag](https://docs.astro.build/en/reference/legacy-flags/#collectionsbackwardscompat) to upgrade to v6 without updating your collections. This temporary flag preserves some legacy v4 content collections features, and will allow you to keep your collections in their current state until the legacy flag is no longer supported. + +- [#3704](https://github.com/withastro/starlight/pull/3704) [`375edcc`](https://github.com/withastro/starlight/commit/375edccde7f8d18e0ce2140de0632c2ad72e3ff8) Thanks [@florian-lefebvre](https://github.com/florian-lefebvre)! - Fixes autocomplete for components exported from `@astrojs/starlight/components/*` + + **⚠️ Potentially breaking change:** This change moves some files used in Starlight’s component internals out of the `components/` directory. Direct use of these files was not and is not officially supported. If you previously imported `TableOfContents/starlight-toc.ts`, `TableOfContents/TableOfContentsList.astro`, `Icons.ts`, or `SidebarPersistState.ts`, please review your code when updating. + +- [#3729](https://github.com/withastro/starlight/pull/3729) [`3642625`](https://github.com/withastro/starlight/commit/3642625db19a37abb535e00036414c84e1c16933) Thanks [@delucis](https://github.com/delucis)! - Improves Starlight’s default body font stack to better support languages such as Chinese, Japanese, and Korean on Windows. + For most users there should be no visible change. + + If you would prefer to keep the previous font stack, you can add the following custom CSS to your site: + + ```css + :root { + --sl-font-system: ui-sans-serif, system-ui, 'Segoe UI', Roboto, + 'Helvetica Neue', Arial, 'Noto Sans', sans-serif, 'Apple Color Emoji', + 'Segoe UI Emoji', 'Segoe UI Symbol', 'Noto Color Emoji'; + } + ``` + +- [#3598](https://github.com/withastro/starlight/pull/3598) [`fff38d5`](https://github.com/withastro/starlight/commit/fff38d58b637c78b0563f6b02e44a41c13106cdb) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Makes hover styles consistent in Starlight’s navigation bar + + Previously, the social icon links and language/theme switchers in Starlight’s navigation bar, dimmed on hover. + After this change, they now increase in contrast on hover instead. + This matches hover behavior elsewhere, for example in the sidebar, table of contents, or search button. + + ⚠️ **Potentially breaking change:** this is a subtle change to the hover style colors. + If you want to preserve the previous styling, you can add the following [custom CSS](https://starlight.astro.build/guides/css-and-tailwind/#custom-css-styles) to your site: + + ```css + starlight-theme-select label, + starlight-lang-select label { + color: var(--sl-color-gray-1); + + &:hover { + color: var(--sl-color-white); + } + } + + .social-icons a:hover { + color: var(--sl-color-text-accent); + opacity: 0.66; + } + ``` + ## 0.37.7 ### Patch Changes diff --git a/packages/starlight/package.json b/packages/starlight/package.json index f0ca3a6df1b..34884749782 100644 --- a/packages/starlight/package.json +++ b/packages/starlight/package.json @@ -1,6 +1,6 @@ { "name": "@astrojs/starlight", - "version": "0.37.7", + "version": "0.38.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 0ba7890f796..b40c5ac55e9 100644 --- a/packages/tailwind/CHANGELOG.md +++ b/packages/tailwind/CHANGELOG.md @@ -1,5 +1,17 @@ # @astrojs/starlight-tailwind +## 5.0.0 + +### Major Changes + +- [#3644](https://github.com/withastro/starlight/pull/3644) [`0d2e7ed`](https://github.com/withastro/starlight/commit/0d2e7ed74a604b028fcab0c81b4c35c0c9365343) Thanks [@HiDeoo](https://github.com/HiDeoo)! - ⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now 0.38.0 + + Please use the `@astrojs/upgrade` command to upgrade your project: + + ```sh + npx @astrojs/upgrade + ``` + ## 4.0.2 ### Patch Changes diff --git a/packages/tailwind/package.json b/packages/tailwind/package.json index 7d39c263901..08f805a3e85 100644 --- a/packages/tailwind/package.json +++ b/packages/tailwind/package.json @@ -1,6 +1,6 @@ { "name": "@astrojs/starlight-tailwind", - "version": "4.0.2", + "version": "5.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 3ce3ec270cd..49240e91f70 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -96,7 +96,7 @@ importers: examples/basics: dependencies: '@astrojs/starlight': - specifier: ^0.37.7 + specifier: ^0.38.0 version: link:../../packages/starlight astro: specifier: ^6.0.1 @@ -111,10 +111,10 @@ importers: specifier: ^1.0.0 version: 1.0.0(astro@6.0.1(@types/node@24.12.0)(jiti@2.6.1)(lightningcss@1.30.2)(rollup@4.53.3)(tsx@4.15.2)(typescript@5.6.3)(yaml@2.7.1)) '@astrojs/starlight': - specifier: ^0.37.7 + specifier: ^0.38.0 version: link:../../packages/starlight '@astrojs/starlight-markdoc': - specifier: ^0.5.1 + specifier: ^0.6.0 version: link:../../packages/markdoc astro: specifier: ^6.0.1 @@ -126,10 +126,10 @@ importers: examples/tailwind: dependencies: '@astrojs/starlight': - specifier: ^0.37.7 + specifier: ^0.38.0 version: link:../../packages/starlight '@astrojs/starlight-tailwind': - specifier: ^4.0.2 + specifier: ^5.0.0 version: link:../../packages/tailwind '@tailwindcss/vite': specifier: ^4.1.18