summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHouston (Bot)2024-08-16 10:18:18 -0700
committerGitHub2024-08-16 19:18:18 +0200
commit96d596743eb6297ad6ef207d036fec84c332faa6 (patch)
treea8d41f2d073730e5c9c166f51b44422933eb926e
parentcaa84eaa7dc653d27d539fd3a93df346a9f0f149 (diff)
downloadIT.starlight-96d596743eb6297ad6ef207d036fec84c332faa6.tar.gz
IT.starlight-96d596743eb6297ad6ef207d036fec84c332faa6.tar.bz2
IT.starlight-96d596743eb6297ad6ef207d036fec84c332faa6.zip
[ci] release (#2217)@astrojs/starlight@0.26.0
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
-rw-r--r--.changeset/chilled-kiwis-count.md56
-rw-r--r--.changeset/chilled-pots-eat.md5
-rw-r--r--.changeset/silver-houses-lick.md5
-rw-r--r--.changeset/swift-laws-yawn.md14
-rw-r--r--.changeset/thirty-students-sit.md16
-rw-r--r--.changeset/weak-insects-hope.md5
-rw-r--r--examples/basics/package.json2
-rw-r--r--examples/tailwind/package.json2
-rw-r--r--packages/starlight/CHANGELOG.md94
-rw-r--r--packages/starlight/package.json2
-rw-r--r--pnpm-lock.yaml4
11 files changed, 99 insertions, 106 deletions
diff --git a/.changeset/chilled-kiwis-count.md b/.changeset/chilled-kiwis-count.md
deleted file mode 100644
index dac9116a..00000000
--- a/.changeset/chilled-kiwis-count.md
+++ /dev/null
@@ -1,56 +0,0 @@
----
-'@astrojs/starlight': minor
----
-
-⚠️ **BREAKING CHANGE:** Updates the `<StarlightPage />` 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 `<StarlightPage />` component, allows for shared sidebar configuration between the global `sidebar` option and `<StarlightPage />` component, and also enables the usage of autogenerated sidebar groups with the `<StarlightPage />` component.
-If you are using the `<StarlightPage />` 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
----
-
-<StarlightPage
- frontmatter={{ title: 'My custom page' }}
- sidebar={[
- {
- type: 'group',
- label: 'Resources',
- badge: { text: 'New' },
- items: [
- { type: 'link', label: 'Showcase', href: '/showcase/' },
- { type: 'link', label: 'Starlight', href: 'https://starlight.astro.build/' },
- ],
- },
- ]}
->
- <p>This is a custom page with a custom component.</p>
-</StarlightPage>
-```
-
-This configuration will now need to be updated to the following:
-
-```astro
----
-// src/pages/custom-page/example.astro
----
-
-<StarlightPage
- frontmatter={{ title: 'My custom page' }}
- sidebar={[
- {
- label: 'Resources',
- badge: { text: 'New' },
- items: ['showcase', { label: 'Starlight', link: 'https://starlight.astro.build/' }],
- },
- ]}
->
- <p>This is a custom page with a custom component.</p>
-</StarlightPage>
-```
-
-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 e5c56b35..00000000
--- a/.changeset/chilled-pots-eat.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-'@astrojs/starlight': minor
----
-
-Adds `<LinkButton>` 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 413190fa..00000000
--- a/.changeset/silver-houses-lick.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-'@astrojs/starlight': minor
----
-
-Adds persistence to synced `<Tabs>` 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 89c4178b..00000000
--- a/.changeset/swift-laws-yawn.md
+++ /dev/null
@@ -1,14 +0,0 @@
----
-'@astrojs/starlight': minor
----
-
-Adds a guideline to the last step of the `<Steps>` 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 <Steps> 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 1cfa90b6..00000000
--- 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 65b23a97..00000000
--- 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 a590930d..fc505fbd 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 98983135..f513e16c 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 93fc89eb..452efc4f 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 `<LinkButton>` 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 `<Tabs>` 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 `<Steps>` 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 <Steps> 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 `<StarlightPage />` 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 `<StarlightPage />` component, allows for shared sidebar configuration between the global `sidebar` option and `<StarlightPage />` component, and also enables the usage of autogenerated sidebar groups with the `<StarlightPage />` component.
+ If you are using the `<StarlightPage />` 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
+ ---
+
+ <StarlightPage
+ frontmatter={{ title: 'My custom page' }}
+ sidebar={[
+ {
+ type: 'group',
+ label: 'Resources',
+ badge: { text: 'New' },
+ items: [
+ { type: 'link', label: 'Showcase', href: '/showcase/' },
+ {
+ type: 'link',
+ label: 'Starlight',
+ href: 'https://starlight.astro.build/',
+ },
+ ],
+ },
+ ]}
+ >
+ <p>This is a custom page with a custom component.</p>
+ </StarlightPage>
+ ```
+
+ This configuration will now need to be updated to the following:
+
+ ```astro
+ ---
+ // src/pages/custom-page/example.astro
+ ---
+
+ <StarlightPage
+ frontmatter={{ title: 'My custom page' }}
+ sidebar={[
+ {
+ label: 'Resources',
+ badge: { text: 'New' },
+ items: [
+ 'showcase',
+ { label: 'Starlight', link: 'https://starlight.astro.build/' },
+ ],
+ },
+ ]}
+ >
+ <p>This is a custom page with a custom component.</p>
+ </StarlightPage>
+ ```
+
+ 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 d331676a..a76a3857 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 f939b0ef..1b8a4e88 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