From 8f22a97acb48e656c30d80a8532533441e21de95 Mon Sep 17 00:00:00 2001 From: "Houston (Bot)" <108291165+astrobot-houston@users.noreply.github.com> Date: Fri, 17 May 2024 09:58:01 -0700 Subject: [PATCH] [ci] release (#1890) Co-authored-by: github-actions[bot] --- .changeset/perfect-chicken-dream.md | 26 ------- .changeset/proud-walls-thank.md | 5 -- .changeset/stale-badgers-fetch.md | 11 --- examples/basics/package.json | 2 +- examples/tailwind/package.json | 2 +- packages/starlight/CHANGELOG.md | 105 +++++++++++++++++++--------- packages/starlight/package.json | 2 +- pnpm-lock.yaml | 4 +- 8 files changed, 76 insertions(+), 81 deletions(-) delete mode 100644 .changeset/perfect-chicken-dream.md delete mode 100644 .changeset/proud-walls-thank.md delete mode 100644 .changeset/stale-badgers-fetch.md diff --git a/.changeset/perfect-chicken-dream.md b/.changeset/perfect-chicken-dream.md deleted file mode 100644 index e6740586eb1..00000000000 --- a/.changeset/perfect-chicken-dream.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -Updates `@astrojs/mdx` to v3 and enables MDX optimization by default - -⚠️ **Potentially breaking change:** MDX optimization speeds up builds (Starlight’s docs are building ~40% faster for example), but restricts some advanced MDX features. See full details in the [MDX optimization documentation](https://docs.astro.build/en/guides/integrations-guide/mdx/#optimize). - -Most Starlight users should be unaffected, but if you are using MDX files outside of Starlight pages with the `components` prop, you may see issues. You can disable optimization by adding MDX manually to your `integrations` array in `astro.config.mjs`: - -```diff -import { defineConfig } from 'astro/config'; -+ import mdx from '@astrojs/mdx'; -import starlight from '@astrojs/starlight'; - -// https://astro.build/config -export default defineConfig({ - integrations: [ - starlight({ - title: 'My docs', - // ... - }), -+ mdx(), - ], -}); -``` diff --git a/.changeset/proud-walls-thank.md b/.changeset/proud-walls-thank.md deleted file mode 100644 index 5f4ede62c17..00000000000 --- a/.changeset/proud-walls-thank.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -Adds custom styles for `
` and `` elements in Markdown content. diff --git a/.changeset/stale-badgers-fetch.md b/.changeset/stale-badgers-fetch.md deleted file mode 100644 index 4c2ad254164..00000000000 --- a/.changeset/stale-badgers-fetch.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -'@astrojs/starlight': minor ---- - -⚠️ **BREAKING CHANGE:** The minimum supported version of Astro is now 4.8.6 - -Please update Astro and Starlight together: - -```sh -npx @astrojs/upgrade -``` diff --git a/examples/basics/package.json b/examples/basics/package.json index b4abefa1e51..05a33a0cdf8 100644 --- a/examples/basics/package.json +++ b/examples/basics/package.json @@ -11,7 +11,7 @@ "astro": "astro" }, "dependencies": { - "@astrojs/starlight": "^0.22.4", + "@astrojs/starlight": "^0.23.0", "astro": "^4.8.6", "sharp": "^0.32.5" } diff --git a/examples/tailwind/package.json b/examples/tailwind/package.json index 6b7cae36638..27559646319 100644 --- a/examples/tailwind/package.json +++ b/examples/tailwind/package.json @@ -11,7 +11,7 @@ "astro": "astro" }, "dependencies": { - "@astrojs/starlight": "^0.22.4", + "@astrojs/starlight": "^0.23.0", "@astrojs/starlight-tailwind": "^2.0.2", "@astrojs/tailwind": "^5.1.0", "astro": "^4.8.6", diff --git a/packages/starlight/CHANGELOG.md b/packages/starlight/CHANGELOG.md index 04cafdf9326..ab69697a754 100644 --- a/packages/starlight/CHANGELOG.md +++ b/packages/starlight/CHANGELOG.md @@ -1,5 +1,42 @@ # @astrojs/starlight +## 0.23.0 + +### Minor Changes + +- [#1846](https://github.com/withastro/starlight/pull/1846) [`2de67039`](https://github.com/withastro/starlight/commit/2de6703971908cfc0df2915ebf89a63e0141f954) Thanks [@delucis](https://github.com/delucis)! - Updates `@astrojs/mdx` to v3 and enables MDX optimization by default + + ⚠️ **Potentially breaking change:** MDX optimization speeds up builds (Starlight’s docs are building ~40% faster for example), but restricts some advanced MDX features. See full details in the [MDX optimization documentation](https://docs.astro.build/en/guides/integrations-guide/mdx/#optimize). + + Most Starlight users should be unaffected, but if you are using MDX files outside of Starlight pages with the `components` prop, you may see issues. You can disable optimization by adding MDX manually to your `integrations` array in `astro.config.mjs`: + + ```diff + import { defineConfig } from 'astro/config'; + + import mdx from '@astrojs/mdx'; + import starlight from '@astrojs/starlight'; + + // https://astro.build/config + export default defineConfig({ + integrations: [ + starlight({ + title: 'My docs', + // ... + }), + + mdx(), + ], + }); + ``` + +- [#1735](https://github.com/withastro/starlight/pull/1735) [`1a9ab50d`](https://github.com/withastro/starlight/commit/1a9ab50d458d6274994ffe66a23fe7a30681337a) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds custom styles for `
` and `` elements in Markdown content. + +- [#1846](https://github.com/withastro/starlight/pull/1846) [`2de67039`](https://github.com/withastro/starlight/commit/2de6703971908cfc0df2915ebf89a63e0141f954) Thanks [@delucis](https://github.com/delucis)! - ⚠️ **BREAKING CHANGE:** The minimum supported version of Astro is now 4.8.6 + + Please update Astro and Starlight together: + + ```sh + npx @astrojs/upgrade + ``` + ## 0.22.4 ### Patch Changes @@ -69,7 +106,7 @@ ```css :root { - --sl-line-height: 1.8; + --sl-line-height: 1.8; } ``` @@ -309,7 +346,7 @@ ```css .sl-link-card a { - line-height: 1.6; + line-height: 1.6; } ``` @@ -329,14 +366,14 @@ ```css /* Restore vertical spacing to match Starlight v0.15 and below. */ .sl-markdown-content - :not(a, strong, em, del, span, input, code) - + :not(a, strong, em, del, span, input, code, :where(.not-content *)) { - margin-top: 1.5rem; + :not(a, strong, em, del, span, input, code) + + :not(a, strong, em, del, span, input, code, :where(.not-content *)) { + margin-top: 1.5rem; } .sl-markdown-content - :not(h1, h2, h3, h4, h5, h6) - + :is(h1, h2, h3, h4, h5, h6):not(:where(.not-content *)) { - margin-top: 2.5rem; + :not(h1, h2, h3, h4, h5, h6) + + :is(h1, h2, h3, h4, h5, h6):not(:where(.not-content *)) { + margin-top: 2.5rem; } ``` @@ -348,9 +385,9 @@ starlight-toc a[aria-current='true'], starlight-toc a[aria-current='true']:hover, starlight-toc a[aria-current='true']:focus { - font-weight: 600; - color: var(--sl-color-text-invert); - background-color: var(--sl-color-text-accent); + font-weight: 600; + color: var(--sl-color-text-invert); + background-color: var(--sl-color-text-accent); } ``` @@ -423,14 +460,14 @@ import starlight from '@astrojs/starlight'; export default defineConfig({ - // Disable link prefetching: - prefetch: false, - - integrations: [ - starlight({ - // ... - }), - ], + // Disable link prefetching: + prefetch: false, + + integrations: [ + starlight({ + // ... + }), + ], }); ``` @@ -487,12 +524,12 @@ import starlight from '@astrojs/starlight'; export default defineConfig({ - trailingSlash: 'always', - integrations: [ - starlight({ - // ... - }), - ], + trailingSlash: 'always', + integrations: [ + starlight({ + // ... + }), + ], }); ``` @@ -840,16 +877,16 @@ ```css :root { - --sl-hue-accent: 234; - --sl-color-accent-low: hsl(var(--sl-hue-accent), 54%, 20%); - --sl-color-accent: hsl(var(--sl-hue-accent), 100%, 60%); - --sl-color-accent-high: hsl(var(--sl-hue-accent), 100%, 87%); + --sl-hue-accent: 234; + --sl-color-accent-low: hsl(var(--sl-hue-accent), 54%, 20%); + --sl-color-accent: hsl(var(--sl-hue-accent), 100%, 60%); + --sl-color-accent-high: hsl(var(--sl-hue-accent), 100%, 87%); } :root[data-theme='light'] { - --sl-color-accent-high: hsl(var(--sl-hue-accent), 80%, 30%); - --sl-color-accent: hsl(var(--sl-hue-accent), 90%, 60%); - --sl-color-accent-low: hsl(var(--sl-hue-accent), 88%, 90%); + --sl-color-accent-high: hsl(var(--sl-hue-accent), 80%, 30%); + --sl-color-accent: hsl(var(--sl-hue-accent), 90%, 60%); + --sl-color-accent-low: hsl(var(--sl-hue-accent), 88%, 90%); } ``` @@ -1228,8 +1265,8 @@ ```json { - "search.label": "Suchen", - "search.shortcutLabel": "(Drücke / zum Suchen)" + "search.label": "Suchen", + "search.shortcutLabel": "(Drücke / zum Suchen)" } ``` diff --git a/packages/starlight/package.json b/packages/starlight/package.json index 2c9f47d3de5..92d4ecf920c 100644 --- a/packages/starlight/package.json +++ b/packages/starlight/package.json @@ -1,6 +1,6 @@ { "name": "@astrojs/starlight", - "version": "0.22.4", + "version": "0.23.0", "description": "Build beautiful, high-performance documentation websites with Astro", "scripts": { "test": "vitest", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index a119bcbd1e7..7d2f139c089 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -73,7 +73,7 @@ importers: examples/basics: dependencies: '@astrojs/starlight': - specifier: ^0.22.4 + specifier: ^0.23.0 version: link:../../packages/starlight astro: specifier: ^4.8.6 @@ -85,7 +85,7 @@ importers: examples/tailwind: dependencies: '@astrojs/starlight': - specifier: ^0.22.4 + specifier: ^0.23.0 version: link:../../packages/starlight '@astrojs/starlight-tailwind': specifier: ^2.0.2