diff --git a/.changeset/big-buttons-shop.md b/.changeset/big-buttons-shop.md deleted file mode 100644 index ea6ed5e18db..00000000000 --- a/.changeset/big-buttons-shop.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -Removes the `/` search shortcut for [accessibility reasons](https://www.w3.org/WAI/WCAG21/Understanding/character-key-shortcuts.html). - -⚠️ **Potentially breaking change:** The `search.shortcutLabel` UI string has been removed. If you were using this string in your custom UI, you will need to update your code. diff --git a/.changeset/curly-dolphins-grow.md b/.changeset/curly-dolphins-grow.md deleted file mode 100644 index 113ed658519..00000000000 --- a/.changeset/curly-dolphins-grow.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@astrojs/starlight": minor ---- - -Improves styling of Markdown tables to work better in different contexts, including against different background colours like when used in asides. diff --git a/.changeset/great-plums-study.md b/.changeset/great-plums-study.md deleted file mode 100644 index 17765e18097..00000000000 --- a/.changeset/great-plums-study.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -Makes sidebar entry parsing stricter in Starlight config - -**⚠️ Potentially breaking change:** Previously Starlight would accept a sidebar entry that matched one of its expected shapes, even if it included additional properties. For example, including both `link` and `items` was considered valid, with `items` being ignored. Now, it is an error to include more than one of `link`, `items`, or `autogenerate` in a sidebar entry. - -If you see errors after updating, look for sidebar entries in the Starlight configuration in `astro.config.mjs` that include too many keys and remove the one that was previously ignored. diff --git a/.changeset/new-trains-complain.md b/.changeset/new-trains-complain.md deleted file mode 100644 index cf35248953f..00000000000 --- a/.changeset/new-trains-complain.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@astrojs/starlight": patch ---- - -Updates the Ukrainian UI translations diff --git a/.changeset/seven-owls-taste.md b/.changeset/seven-owls-taste.md deleted file mode 100644 index ce108075dd5..00000000000 --- a/.changeset/seven-owls-taste.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -'@astrojs/starlight': patch ---- - -Adds a new syntax for specifying sidebar link items for internal links - -You can now specify an internal page using only its slug, either as a string, or as an object with a `slug` property: - -```js -starlight({ - title: 'Docs with easier sidebars', - sidebar: [ - 'getting-started', - { slug: 'guides/installation' }, - ], -}) -``` - -Starlight will use the linked page’s frontmatter to configure the sidebar link. diff --git a/examples/basics/package.json b/examples/basics/package.json index 4d0586b39f2..cff8a92d205 100644 --- a/examples/basics/package.json +++ b/examples/basics/package.json @@ -11,7 +11,7 @@ "astro": "astro" }, "dependencies": { - "@astrojs/starlight": "^0.24.5", + "@astrojs/starlight": "^0.25.0", "astro": "^4.10.2", "sharp": "^0.32.5" } diff --git a/examples/tailwind/package.json b/examples/tailwind/package.json index 8c2691e44be..efb25b316aa 100644 --- a/examples/tailwind/package.json +++ b/examples/tailwind/package.json @@ -11,7 +11,7 @@ "astro": "astro" }, "dependencies": { - "@astrojs/starlight": "^0.24.5", + "@astrojs/starlight": "^0.25.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 5f5a100c6f4..9246bc9d369 100644 --- a/packages/starlight/CHANGELOG.md +++ b/packages/starlight/CHANGELOG.md @@ -1,5 +1,38 @@ # @astrojs/starlight +## 0.25.0 + +### Minor Changes + +- [#2025](https://github.com/withastro/starlight/pull/2025) [`47f32c1`](https://github.com/withastro/starlight/commit/47f32c196c5d840a6a45799ddf123d17c77274b0) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Removes the `/` search shortcut for [accessibility reasons](https://www.w3.org/WAI/WCAG21/Understanding/character-key-shortcuts.html). + + ⚠️ **Potentially breaking change:** The `search.shortcutLabel` UI string has been removed. If you were using this string in your custom UI, you will need to update your code. + +- [#2064](https://github.com/withastro/starlight/pull/2064) [`c5b47cb`](https://github.com/withastro/starlight/commit/c5b47cbe1242f0b29b9212db72fe26590ab57d88) Thanks [@SnowDingo](https://github.com/SnowDingo)! - Improves styling of Markdown tables to work better in different contexts, including against different background colours like when used in asides. + +- [#2031](https://github.com/withastro/starlight/pull/2031) [`2bab648`](https://github.com/withastro/starlight/commit/2bab648be9ddc6bfe05562650b773f5158a9ed42) Thanks [@delucis](https://github.com/delucis)! - Makes sidebar entry parsing stricter in Starlight config + + **⚠️ Potentially breaking change:** Previously Starlight would accept a sidebar entry that matched one of its expected shapes, even if it included additional properties. For example, including both `link` and `items` was considered valid, with `items` being ignored. Now, it is an error to include more than one of `link`, `items`, or `autogenerate` in a sidebar entry. + + If you see errors after updating, look for sidebar entries in the Starlight configuration in `astro.config.mjs` that include too many keys and remove the one that was previously ignored. + +### Patch Changes + +- [#2081](https://github.com/withastro/starlight/pull/2081) [`f0181d2`](https://github.com/withastro/starlight/commit/f0181d2689248a46ff3eb6fc604bfcd95d4cb1aa) Thanks [@andrii-bodnar](https://github.com/andrii-bodnar)! - Updates the Ukrainian UI translations + +- [#1874](https://github.com/withastro/starlight/pull/1874) [`eeba06e`](https://github.com/withastro/starlight/commit/eeba06ea7df962e8f0520e145d28b8c17cd32c18) Thanks [@lorenzolewis](https://github.com/lorenzolewis)! - Adds a new syntax for specifying sidebar link items for internal links + + You can now specify an internal page using only its slug, either as a string, or as an object with a `slug` property: + + ```js + starlight({ + title: 'Docs with easier sidebars', + sidebar: ['getting-started', { slug: 'guides/installation' }], + }); + ``` + + Starlight will use the linked page’s frontmatter to configure the sidebar link. + ## 0.24.5 ### Patch Changes diff --git a/packages/starlight/package.json b/packages/starlight/package.json index 020256f807d..2833e86676a 100644 --- a/packages/starlight/package.json +++ b/packages/starlight/package.json @@ -1,6 +1,6 @@ { "name": "@astrojs/starlight", - "version": "0.24.5", + "version": "0.25.0", "description": "Build beautiful, high-performance documentation websites with Astro", "scripts": { "test": "vitest", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 37078d8d1cb..668a4842b95 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -73,7 +73,7 @@ importers: examples/basics: dependencies: '@astrojs/starlight': - specifier: ^0.24.5 + specifier: ^0.25.0 version: link:../../packages/starlight astro: specifier: ^4.10.2 @@ -85,7 +85,7 @@ importers: examples/tailwind: dependencies: '@astrojs/starlight': - specifier: ^0.24.5 + specifier: ^0.25.0 version: link:../../packages/starlight '@astrojs/starlight-tailwind': specifier: ^2.0.3