From 96d596743eb6297ad6ef207d036fec84c332faa6 Mon Sep 17 00:00:00 2001 From: "Houston (Bot)" <108291165+astrobot-houston@users.noreply.github.com> Date: Fri, 16 Aug 2024 10:18:18 -0700 Subject: [PATCH] [ci] release (#2217) Co-authored-by: github-actions[bot] Co-authored-by: Chris Swithinbank --- .changeset/chilled-kiwis-count.md | 56 ------------------ .changeset/chilled-pots-eat.md | 5 -- .changeset/silver-houses-lick.md | 5 -- .changeset/swift-laws-yawn.md | 14 ----- .changeset/thirty-students-sit.md | 16 ------ .changeset/weak-insects-hope.md | 5 -- examples/basics/package.json | 2 +- examples/tailwind/package.json | 2 +- packages/starlight/CHANGELOG.md | 94 +++++++++++++++++++++++++++++++ packages/starlight/package.json | 2 +- pnpm-lock.yaml | 4 +- 11 files changed, 99 insertions(+), 106 deletions(-) delete mode 100644 .changeset/chilled-kiwis-count.md delete mode 100644 .changeset/chilled-pots-eat.md delete mode 100644 .changeset/silver-houses-lick.md delete mode 100644 .changeset/swift-laws-yawn.md delete mode 100644 .changeset/thirty-students-sit.md delete mode 100644 .changeset/weak-insects-hope.md diff --git a/.changeset/chilled-kiwis-count.md b/.changeset/chilled-kiwis-count.md deleted file mode 100644 index dac9116a00..0000000000 --- a/.changeset/chilled-kiwis-count.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -⚠️ **BREAKING CHANGE:** Updates the `` component `sidebar` prop to accept an array of [`SidebarItem`](https://starlight.astro.build/reference/configuration/#sidebaritem)s like the main Starlight `sidebar` configuration in `astro.config.mjs`. - -This change simplifies the definition of sidebar items in the `` component, allows for shared sidebar configuration between the global `sidebar` option and `` component, and also enables the usage of autogenerated sidebar groups with the `` component. -If you are using the `` component with a custom `sidebar` configuration, you will need to update the `sidebar` prop to an array of [`SidebarItem`](https://starlight.astro.build/reference/configuration/#sidebaritem) objects. - -For example, the following custom page with a custom `sidebar` configuration defines a “Resources” group with a “New” badge, a link to the “Showcase” page which is part of the `docs` content collection, and a link to the Starlight website: - -```astro ---- -// src/pages/custom-page/example.astro ---- - - -

This is a custom page with a custom component.

- -``` - -This configuration will now need to be updated to the following: - -```astro ---- -// src/pages/custom-page/example.astro ---- - - -

This is a custom page with a custom component.

- -``` - -See the [“Sidebar Navigation”](https://starlight.astro.build/guides/sidebar/) guide to learn more about the available options for customizing the sidebar. diff --git a/.changeset/chilled-pots-eat.md b/.changeset/chilled-pots-eat.md deleted file mode 100644 index e5c56b35d5..0000000000 --- a/.changeset/chilled-pots-eat.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -Adds `` component for visually distinct and emphasized call to action links diff --git a/.changeset/silver-houses-lick.md b/.changeset/silver-houses-lick.md deleted file mode 100644 index 413190fa48..0000000000 --- a/.changeset/silver-houses-lick.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -Adds persistence to synced `` so that a user's choices are reflected across page navigations. diff --git a/.changeset/swift-laws-yawn.md b/.changeset/swift-laws-yawn.md deleted file mode 100644 index 89c4178bd9..0000000000 --- a/.changeset/swift-laws-yawn.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -Adds a guideline to the last step of the `` component. - -If you want to preserve the previous behaviour and hide the guideline on final steps, you can add the following custom CSS to your site: - -```css -/* Hide the guideline for the final step in lists. */ -.sl-steps > li:last-of-type::after { - background: transparent; -} -``` diff --git a/.changeset/thirty-students-sit.md b/.changeset/thirty-students-sit.md deleted file mode 100644 index 1cfa90b69a..0000000000 --- a/.changeset/thirty-students-sit.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -Changes the hero component action button default [variant](https://starlight.astro.build/reference/frontmatter/#heroconfig) from `minimal` to `primary`. - -If you want to preserve the previous behavior, hero component action buttons previously declared without a `variant` will need to be updated to include the `variant` property with the value `minimal`. - -```diff -hero: - actions: - - text: View on GitHub - link: https://github.com/astronaut/my-project - icon: external -+ variant: minimal -``` diff --git a/.changeset/weak-insects-hope.md b/.changeset/weak-insects-hope.md deleted file mode 100644 index 65b23a9706..0000000000 --- a/.changeset/weak-insects-hope.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -Adds state persistence across page navigations to the main site sidebar diff --git a/examples/basics/package.json b/examples/basics/package.json index a590930d2d..fc505fbd5a 100644 --- a/examples/basics/package.json +++ b/examples/basics/package.json @@ -11,7 +11,7 @@ "astro": "astro" }, "dependencies": { - "@astrojs/starlight": "^0.25.5", + "@astrojs/starlight": "^0.26.0", "astro": "^4.10.2", "sharp": "^0.32.5" } diff --git a/examples/tailwind/package.json b/examples/tailwind/package.json index 98983135ca..f513e16cf9 100644 --- a/examples/tailwind/package.json +++ b/examples/tailwind/package.json @@ -11,7 +11,7 @@ "astro": "astro" }, "dependencies": { - "@astrojs/starlight": "^0.25.5", + "@astrojs/starlight": "^0.26.0", "@astrojs/starlight-tailwind": "^2.0.3", "@astrojs/tailwind": "^5.1.0", "astro": "^4.10.2", diff --git a/packages/starlight/CHANGELOG.md b/packages/starlight/CHANGELOG.md index 93fc89eb12..452efc4ffc 100644 --- a/packages/starlight/CHANGELOG.md +++ b/packages/starlight/CHANGELOG.md @@ -1,5 +1,99 @@ # @astrojs/starlight +## 0.26.0 + +### Minor Changes + +- [#1784](https://github.com/withastro/starlight/pull/1784) [`68f56a7`](https://github.com/withastro/starlight/commit/68f56a7ffd314b760443a057db9ed1a982dbe191) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds `` component for visually distinct and emphasized call to action links + +- [#2150](https://github.com/withastro/starlight/pull/2150) [`9368494`](https://github.com/withastro/starlight/commit/9368494210dbcd80ada5b410340814fe36c4eb6c) Thanks [@delucis](https://github.com/delucis)! - Adds state persistence across page navigations to the main site sidebar + +- [#2087](https://github.com/withastro/starlight/pull/2087) [`caa84ea`](https://github.com/withastro/starlight/commit/caa84eaa7dc653d27d539fd3a93df346a9f0f149) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds persistence to synced `` so that a user's choices are reflected across page navigations. + +- [#2051](https://github.com/withastro/starlight/pull/2051) [`ec3b579`](https://github.com/withastro/starlight/commit/ec3b5794cac55a5755620fa5e205f0d54c9e343b) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds a guideline to the last step of the `` component. + + If you want to preserve the previous behaviour and hide the guideline on final steps, you can add the following custom CSS to your site: + + ```css + /* Hide the guideline for the final step in lists. */ + .sl-steps > li:last-of-type::after { + background: transparent; + } + ``` + +- [#1784](https://github.com/withastro/starlight/pull/1784) [`68f56a7`](https://github.com/withastro/starlight/commit/68f56a7ffd314b760443a057db9ed1a982dbe191) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Changes the hero component action button default [variant](https://starlight.astro.build/reference/frontmatter/#heroconfig) from `minimal` to `primary`. + + ⚠️ **BREAKING CHANGE:** If you want to preserve the previous appearance, hero component action buttons previously declared without a `variant` will need to be updated to include the `variant` property with the value `minimal`. + + ```diff + hero: + actions: + - text: View on GitHub + link: https://github.com/astronaut/my-project + icon: external + + variant: minimal + ``` + +- [#2168](https://github.com/withastro/starlight/pull/2168) [`e044fee`](https://github.com/withastro/starlight/commit/e044feeae9a336a87db526107e5772b54ddc567f) Thanks [@HiDeoo](https://github.com/HiDeoo)! - ⚠️ **BREAKING CHANGE:** Updates the `` component `sidebar` prop to accept an array of [`SidebarItem`](https://starlight.astro.build/reference/configuration/#sidebaritem)s like the main Starlight `sidebar` configuration in `astro.config.mjs`. + + This change simplifies the definition of sidebar items in the `` component, allows for shared sidebar configuration between the global `sidebar` option and `` component, and also enables the usage of autogenerated sidebar groups with the `` component. + If you are using the `` component with a custom `sidebar` configuration, you will need to update the `sidebar` prop to an array of [`SidebarItem`](https://starlight.astro.build/reference/configuration/#sidebaritem) objects. + + For example, the following custom page with a custom `sidebar` configuration defines a “Resources” group with a “New” badge, a link to the “Showcase” page which is part of the `docs` content collection, and a link to the Starlight website: + + ```astro + --- + // src/pages/custom-page/example.astro + --- + + +

This is a custom page with a custom component.

+ + ``` + + This configuration will now need to be updated to the following: + + ```astro + --- + // src/pages/custom-page/example.astro + --- + + +

This is a custom page with a custom component.

+ + ``` + + See the [“Sidebar Navigation”](https://starlight.astro.build/guides/sidebar/) guide to learn more about the available options for customizing the sidebar. + ## 0.25.5 ### Patch Changes diff --git a/packages/starlight/package.json b/packages/starlight/package.json index d331676a30..a76a3857c3 100644 --- a/packages/starlight/package.json +++ b/packages/starlight/package.json @@ -1,6 +1,6 @@ { "name": "@astrojs/starlight", - "version": "0.25.5", + "version": "0.26.0", "description": "Build beautiful, high-performance documentation websites with Astro", "scripts": { "test": "vitest", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index f939b0ef5b..1b8a4e881e 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -73,7 +73,7 @@ importers: examples/basics: dependencies: '@astrojs/starlight': - specifier: ^0.25.5 + specifier: ^0.26.0 version: link:../../packages/starlight astro: specifier: ^4.10.2 @@ -85,7 +85,7 @@ importers: examples/tailwind: dependencies: '@astrojs/starlight': - specifier: ^0.25.5 + specifier: ^0.26.0 version: link:../../packages/starlight '@astrojs/starlight-tailwind': specifier: ^2.0.3