Skip to content

Commit

Permalink
[ci] release (#2217)
Browse files Browse the repository at this point in the history
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
  • Loading branch information
3 people committed Aug 16, 2024
1 parent caa84ea commit 96d5967
Show file tree
Hide file tree
Showing 11 changed files with 99 additions and 106 deletions.
56 changes: 0 additions & 56 deletions .changeset/chilled-kiwis-count.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/chilled-pots-eat.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/silver-houses-lick.md

This file was deleted.

14 changes: 0 additions & 14 deletions .changeset/swift-laws-yawn.md

This file was deleted.

16 changes: 0 additions & 16 deletions .changeset/thirty-students-sit.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/weak-insects-hope.md

This file was deleted.

2 changes: 1 addition & 1 deletion examples/basics/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
Expand Down
2 changes: 1 addition & 1 deletion examples/tailwind/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
94 changes: 94 additions & 0 deletions packages/starlight/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/starlight/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
4 changes: 2 additions & 2 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 96d5967

Please sign in to comment.