diff options
author | Houston (Bot) | 2025-04-07 09:02:35 -0700 |
---|---|---|
committer | GitHub | 2025-04-07 18:02:35 +0200 |
commit | cf3cec1b6c065613cb85de417a1e8ae66f03107b (patch) | |
tree | 4647d2398101486dec3244b9cc49859c05bd06e8 | |
parent | f87e9acbf5090a31858c1cde568cc798140f1366 (diff) | |
download | IT.starlight-cf3cec1b6c065613cb85de417a1e8ae66f03107b.tar.gz IT.starlight-cf3cec1b6c065613cb85de417a1e8ae66f03107b.tar.bz2 IT.starlight-cf3cec1b6c065613cb85de417a1e8ae66f03107b.zip |
[ci] release (#3048)@astrojs/starlight@0.33.0
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
-rw-r--r-- | .changeset/calm-cobras-breathe.md | 11 | ||||
-rw-r--r-- | .changeset/gold-sloths-unite.md | 24 | ||||
-rw-r--r-- | .changeset/happy-pens-serve.md | 5 | ||||
-rw-r--r-- | .changeset/happy-snails-cheat.md | 5 | ||||
-rw-r--r-- | .changeset/long-emus-smile.md | 9 | ||||
-rw-r--r-- | .changeset/red-monkeys-tickle.md | 32 | ||||
-rw-r--r-- | .changeset/small-days-share.md | 5 | ||||
-rw-r--r-- | .changeset/swift-hotels-move.md | 5 | ||||
-rw-r--r-- | examples/basics/package.json | 2 | ||||
-rw-r--r-- | examples/markdoc/package.json | 2 | ||||
-rw-r--r-- | examples/tailwind/package.json | 2 | ||||
-rw-r--r-- | packages/starlight/CHANGELOG.md | 79 | ||||
-rw-r--r-- | packages/starlight/package.json | 2 | ||||
-rw-r--r-- | pnpm-lock.yaml | 6 |
14 files changed, 86 insertions, 103 deletions
diff --git a/.changeset/calm-cobras-breathe.md b/.changeset/calm-cobras-breathe.md deleted file mode 100644 index babcfe33..00000000 --- a/.changeset/calm-cobras-breathe.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -Fixes a potential list styling issue if the last element of a list item is a `<script>` tag. - -⚠️ BREAKING CHANGE: - -This release drops official support for Chromium-based browsers prior to version 105 (released 30 August 2022) and Firefox-based browsers prior to version 121 (released 19 December 2023). You can find a list of currently supported browsers and their versions using this [browserslist query](https://browsersl.ist/#q=%3E+0.5%25%2C+not+dead%2C+Chrome+%3E%3D+105%2C+Edge+%3E%3D+105%2C+Firefox+%3E%3D+121%2C+Safari+%3E%3D+15.4%2C+iOS+%3E%3D+15.4%2C+not+op_mini+all). - -With this release, Starlight-generated sites will still work fine on those older browsers except for this small detail in list item styling, but future releases may introduce further breaking changes for impacted browsers, including in patch releases. diff --git a/.changeset/gold-sloths-unite.md b/.changeset/gold-sloths-unite.md deleted file mode 100644 index d81e7ea1..00000000 --- a/.changeset/gold-sloths-unite.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -Makes `social` configuration more flexible. - -⚠️ **BREAKING CHANGE:** The `social` configuration option has changed syntax. You will need to update this in `astro.config.mjs` when upgrading. - -Previously, a limited set of platforms were supported using a shorthand syntax with labels built in to Starlight. While convenient, this approach was less flexible and required dedicated code for each social platform added. - -Now, you must specify the icon and label for each social link explicitly and you can use any of [Starlight’s built-in icons](https://starlight.astro.build/reference/icons/) for social links. - -The following example shows updating the old `social` syntax to the new: - -```diff -- social: { -- github: 'https://github.com/withastro/starlight', -- discord: 'https://astro.build/chat', -- }, -+ social: [ -+ { icon: 'github', label: 'GitHub', href: 'https://github.com/withastro/starlight' }, -+ { icon: 'discord', label: 'Discord', href: 'https://astro.build/chat' }, -+ ], -``` diff --git a/.changeset/happy-pens-serve.md b/.changeset/happy-pens-serve.md deleted file mode 100644 index 9b1fa92e..00000000 --- a/.changeset/happy-pens-serve.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@astrojs/starlight': patch ---- - -Fixes an issue where overriding the [canonical URL](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel#canonical) of a page using the [`head` configuration option](https://starlight.astro.build/reference/configuration/#head) or [`head` frontmatter field](https://starlight.astro.build/reference/frontmatter/#head) would strip any other `<link>` tags from the `<head>`. diff --git a/.changeset/happy-snails-cheat.md b/.changeset/happy-snails-cheat.md deleted file mode 100644 index f2b1ef99..00000000 --- a/.changeset/happy-snails-cheat.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@astrojs/starlight': patch ---- - -Fixes an issue where generated [canonical URLs](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel#canonical) would include a trailing slash when using the [`trailingSlash` Astro option](https://docs.astro.build/en/reference/configuration-reference/#trailingslash) is set to `'never'`. diff --git a/.changeset/long-emus-smile.md b/.changeset/long-emus-smile.md deleted file mode 100644 index 7756acaa..00000000 --- a/.changeset/long-emus-smile.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -Adds the [`head`](https://starlight.astro.build/reference/route-data/#head) route data property which contains an array of all tags to include in the `<head>` of the current page. - -Previously, the [`<Head>`](https://starlight.astro.build/reference/overrides/#head-1) component was responsible for generating a list of tags to include in the `<head>` of the current page and rendering them. -This data is now available as `Astro.locals.starlightRoute.head` instead and can be modified using [route data middleware](https://starlight.astro.build/guides/route-data/#customizing-route-data). -The `<Head>` component now only renders the tags provided in `Astro.locals.starlightRoute.head`. diff --git a/.changeset/red-monkeys-tickle.md b/.changeset/red-monkeys-tickle.md deleted file mode 100644 index 526b1f82..00000000 --- a/.changeset/red-monkeys-tickle.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -⚠️ **BREAKING CHANGE:** Ensures that the `<Badge>` and `<Icon>` components no longer render with a trailing space. - -In Astro, components that include styles render with a trailing space which can prevent some use cases from working as expected, e.g. when using such components inlined with text. This change ensures that the `<Badge>` and `<Icon>` components no longer render with a trailing space. - -If you were previously relying on that implementation detail, you may need to update your code to account for this change. For example, considering the following code: - -```mdx -<Badge text="New" />Feature -``` - -The rendered text would previously include a space between the badge and the text due to the trailing space automatically added by the component: - -``` -New Feature -``` - -Such code will now render the badge and text without a space: - -``` -NewFeature -``` - -To fix this, you can add a space between the badge and the text: - -```diff -- <Badge text="New" />Feature -+ <Badge text="New" /> Feature -``` diff --git a/.changeset/small-days-share.md b/.changeset/small-days-share.md deleted file mode 100644 index 1e9e19c4..00000000 --- a/.changeset/small-days-share.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -Updates mobile menu toggle styles to display a close icon while the menu is open diff --git a/.changeset/swift-hotels-move.md b/.changeset/swift-hotels-move.md deleted file mode 100644 index 78a43e6d..00000000 --- a/.changeset/swift-hotels-move.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@astrojs/starlight': patch ---- - -Fixes Starlight’s autogenerated `<meta name="twitter:site">` tags when a Twitter link is set in `social` config. Previously these incorrectly rendered `content="/username"` and now correctly render `content="@username"`. diff --git a/examples/basics/package.json b/examples/basics/package.json index aaf0667c..7c051732 100644 --- a/examples/basics/package.json +++ b/examples/basics/package.json @@ -11,7 +11,7 @@ "astro": "astro" }, "dependencies": { - "@astrojs/starlight": "^0.32.6", + "@astrojs/starlight": "^0.33.0", "astro": "^5.5.3", "sharp": "^0.32.5" } diff --git a/examples/markdoc/package.json b/examples/markdoc/package.json index bab0c63f..d5f8582d 100644 --- a/examples/markdoc/package.json +++ b/examples/markdoc/package.json @@ -12,7 +12,7 @@ }, "dependencies": { "@astrojs/markdoc": "^0.12.4", - "@astrojs/starlight": "^0.32.6", + "@astrojs/starlight": "^0.33.0", "@astrojs/starlight-markdoc": "^0.3.0", "astro": "^5.5.3", "sharp": "^0.32.5" diff --git a/examples/tailwind/package.json b/examples/tailwind/package.json index 80f7e5c0..c54c2126 100644 --- a/examples/tailwind/package.json +++ b/examples/tailwind/package.json @@ -11,7 +11,7 @@ "astro": "astro" }, "dependencies": { - "@astrojs/starlight": "^0.32.6", + "@astrojs/starlight": "^0.33.0", "@astrojs/starlight-tailwind": "^3.0.1", "@astrojs/tailwind": "^5.1.4", "astro": "^5.5.3", diff --git a/packages/starlight/CHANGELOG.md b/packages/starlight/CHANGELOG.md index 7bd67677..899e52eb 100644 --- a/packages/starlight/CHANGELOG.md +++ b/packages/starlight/CHANGELOG.md @@ -1,5 +1,84 @@ # @astrojs/starlight +## 0.33.0 + +### Minor Changes + +- [#3026](https://github.com/withastro/starlight/pull/3026) [`82deb84`](https://github.com/withastro/starlight/commit/82deb847418aedb9c01e05bb9de4b9bd10a1a885) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes a potential list styling issue if the last element of a list item is a `<script>` tag. + + ⚠️ **BREAKING CHANGE:** + + This release drops official support for Chromium-based browsers prior to version 105 (released 30 August 2022) and Firefox-based browsers prior to version 121 (released 19 December 2023). You can find a list of currently supported browsers and their versions using this [browserslist query](https://browsersl.ist/#q=%3E+0.5%25%2C+not+dead%2C+Chrome+%3E%3D+105%2C+Edge+%3E%3D+105%2C+Firefox+%3E%3D+121%2C+Safari+%3E%3D+15.4%2C+iOS+%3E%3D+15.4%2C+not+op_mini+all). + + With this release, Starlight-generated sites will still work fine on those older browsers except for this small detail in list item styling, but future releases may introduce further breaking changes for impacted browsers, including in patch releases. + +- [#3025](https://github.com/withastro/starlight/pull/3025) [`f87e9ac`](https://github.com/withastro/starlight/commit/f87e9acbf5090a31858c1cde568cc798140f1366) Thanks [@delucis](https://github.com/delucis)! - Makes `social` configuration more flexible. + + ⚠️ **BREAKING CHANGE:** The `social` configuration option has changed syntax. You will need to update this in `astro.config.mjs` when upgrading. + + Previously, a limited set of platforms were supported using a shorthand syntax with labels built in to Starlight. While convenient, this approach was less flexible and required dedicated code for each social platform added. + + Now, you must specify the icon and label for each social link explicitly and you can use any of [Starlight’s built-in icons](https://starlight.astro.build/reference/icons/) for social links. + + The following example shows updating the old `social` syntax to the new: + + ```diff + - social: { + - github: 'https://github.com/withastro/starlight', + - discord: 'https://astro.build/chat', + - }, + + social: [ + + { icon: 'github', label: 'GitHub', href: 'https://github.com/withastro/starlight' }, + + { icon: 'discord', label: 'Discord', href: 'https://astro.build/chat' }, + + ], + ``` + +- [#2927](https://github.com/withastro/starlight/pull/2927) [`c46904c`](https://github.com/withastro/starlight/commit/c46904c4a16cf1c7f4f895e42cb164474b2301b3) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds the [`head`](https://starlight.astro.build/reference/route-data/#head) route data property which contains an array of all tags to include in the `<head>` of the current page. + + Previously, the [`<Head>`](https://starlight.astro.build/reference/overrides/#head-1) component was responsible for generating a list of tags to include in the `<head>` of the current page and rendering them. + This data is now available as `Astro.locals.starlightRoute.head` instead and can be modified using [route data middleware](https://starlight.astro.build/guides/route-data/#customizing-route-data). + The `<Head>` component now only renders the tags provided in `Astro.locals.starlightRoute.head`. + +- [#2924](https://github.com/withastro/starlight/pull/2924) [`6a56d1b`](https://github.com/withastro/starlight/commit/6a56d1b80d9d67e63e930177cf085a25864e1952) Thanks [@HiDeoo](https://github.com/HiDeoo)! - ⚠️ **BREAKING CHANGE:** Ensures that the `<Badge>` and `<Icon>` components no longer render with a trailing space. + + In Astro, components that include styles render with a trailing space which can prevent some use cases from working as expected, e.g. when using such components inlined with text. This change ensures that the `<Badge>` and `<Icon>` components no longer render with a trailing space. + + If you were previously relying on that implementation detail, you may need to update your code to account for this change. For example, considering the following code: + + ```mdx + <Badge text="New" /> + Feature + ``` + + The rendered text would previously include a space between the badge and the text due to the trailing space automatically added by the component: + + ``` + New Feature + ``` + + Such code will now render the badge and text without a space: + + ``` + NewFeature + ``` + + To fix this, you can add a space between the badge and the text: + + ```diff + - <Badge text="New" />Feature + + <Badge text="New" /> Feature + ``` + +- [#2727](https://github.com/withastro/starlight/pull/2727) [`7c8fa30`](https://github.com/withastro/starlight/commit/7c8fa30f0ac2459c83b71a8a7b705b16dcf98d6f) Thanks [@techfg](https://github.com/techfg)! - Updates mobile menu toggle styles to display a close icon while the menu is open + +### Patch Changes + +- [#2927](https://github.com/withastro/starlight/pull/2927) [`c46904c`](https://github.com/withastro/starlight/commit/c46904c4a16cf1c7f4f895e42cb164474b2301b3) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes an issue where overriding the [canonical URL](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel#canonical) of a page using the [`head` configuration option](https://starlight.astro.build/reference/configuration/#head) or [`head` frontmatter field](https://starlight.astro.build/reference/frontmatter/#head) would strip any other `<link>` tags from the `<head>`. + +- [#2927](https://github.com/withastro/starlight/pull/2927) [`c46904c`](https://github.com/withastro/starlight/commit/c46904c4a16cf1c7f4f895e42cb164474b2301b3) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes an issue where generated [canonical URLs](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel#canonical) would include a trailing slash when using the [`trailingSlash` Astro option](https://docs.astro.build/en/reference/configuration-reference/#trailingslash) is set to `'never'`. + +- [#3025](https://github.com/withastro/starlight/pull/3025) [`f87e9ac`](https://github.com/withastro/starlight/commit/f87e9acbf5090a31858c1cde568cc798140f1366) Thanks [@delucis](https://github.com/delucis)! - Fixes Starlight’s autogenerated `<meta name="twitter:site">` tags when a Twitter link is set in `social` config. Previously these incorrectly rendered `content="/username"` and now correctly render `content="@username"`. + ## 0.32.6 ### Patch Changes diff --git a/packages/starlight/package.json b/packages/starlight/package.json index 8fcdea9e..b8fb54ac 100644 --- a/packages/starlight/package.json +++ b/packages/starlight/package.json @@ -1,6 +1,6 @@ { "name": "@astrojs/starlight", - "version": "0.32.6", + "version": "0.33.0", "description": "Build beautiful, high-performance documentation websites with Astro", "scripts": { "test": "vitest", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 34d24551..fdf70ab3 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -76,7 +76,7 @@ importers: examples/basics: dependencies: '@astrojs/starlight': - specifier: ^0.32.6 + specifier: ^0.33.0 version: link:../../packages/starlight astro: specifier: ^5.5.3 @@ -91,7 +91,7 @@ importers: specifier: ^0.12.4 version: 0.12.5(astro@5.5.3) '@astrojs/starlight': - specifier: ^0.32.6 + specifier: ^0.33.0 version: link:../../packages/starlight '@astrojs/starlight-markdoc': specifier: ^0.3.0 @@ -106,7 +106,7 @@ importers: examples/tailwind: dependencies: '@astrojs/starlight': - specifier: ^0.32.6 + specifier: ^0.33.0 version: link:../../packages/starlight '@astrojs/starlight-tailwind': specifier: ^3.0.1 |