diff options
author | Houston (Bot) | 2025-03-03 15:30:26 -0800 |
---|---|---|
committer | GitHub | 2025-03-04 00:30:26 +0100 |
commit | 929b77849caaa8607bff421e99cce5c9d87d678d (patch) | |
tree | d0162fa9140b55858e00efc280c1b88127cf7e1b | |
parent | 10b93b336cf4e3500e3003635b5afc430284d1a7 (diff) | |
download | IT.starlight-929b77849caaa8607bff421e99cce5c9d87d678d.tar.gz IT.starlight-929b77849caaa8607bff421e99cce5c9d87d678d.tar.bz2 IT.starlight-929b77849caaa8607bff421e99cce5c9d87d678d.zip |
[ci] release (#2934)@astrojs/starlight-markdoc@0.3.0
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
-rw-r--r-- | .changeset/healthy-rivers-divide.md | 28 | ||||
-rw-r--r-- | examples/markdoc/package.json | 2 | ||||
-rw-r--r-- | packages/markdoc/CHANGELOG.md | 29 | ||||
-rw-r--r-- | packages/markdoc/package.json | 2 | ||||
-rw-r--r-- | pnpm-lock.yaml | 2 |
5 files changed, 32 insertions, 31 deletions
diff --git a/.changeset/healthy-rivers-divide.md b/.changeset/healthy-rivers-divide.md deleted file mode 100644 index 98988154..00000000 --- a/.changeset/healthy-rivers-divide.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -'@astrojs/starlight-markdoc': minor ---- - -Adds support for the `title`, `frame`, and `meta` fence attributes to code blocks. - -These new optional attributes add support for Expressive Code [text & line markers](https://expressive-code.com/key-features/text-markers/). The following example renders a code block using a [terminal frame](https://expressive-code.com/key-features/frames/#terminal-frames) with a [title](https://expressive-code.com/key-features/frames/#code-editor-frames): - -````mdoc -```js {% title="editor.exe" frame="terminal" %} -console.log('Hello, world!'); -``` -```` - -Any other text or line markers should be specified using the `meta` fence attribute. For example, the following code block renders a code block using the `diff` syntax combined with the `js` language syntax highlighting and the `markers` text highlighted: - -````mdoc -```diff {% meta="lang=js 'markers'" %} - function thisIsJavaScript() { - // This entire block gets highlighted as JavaScript, - // and we can still add diff markers to it! -- console.log('Old code to be removed') -+ console.log('New and shiny code!') - } -``` -```` - -To learn more about all the available options, check out the [Expressive Code documentation](https://expressive-code.com/key-features/text-markers/#usage-in-markdown--mdx). diff --git a/examples/markdoc/package.json b/examples/markdoc/package.json index 98f969e7..84e2d4b0 100644 --- a/examples/markdoc/package.json +++ b/examples/markdoc/package.json @@ -13,7 +13,7 @@ "dependencies": { "@astrojs/markdoc": "^0.12.4", "@astrojs/starlight": "^0.32.2", - "@astrojs/starlight-markdoc": "^0.2.0", + "@astrojs/starlight-markdoc": "^0.3.0", "astro": "^5.1.5", "sharp": "^0.32.5" } diff --git a/packages/markdoc/CHANGELOG.md b/packages/markdoc/CHANGELOG.md index caea5518..391f06ad 100644 --- a/packages/markdoc/CHANGELOG.md +++ b/packages/markdoc/CHANGELOG.md @@ -1,5 +1,34 @@ # @astrojs/starlight-markdoc +## 0.3.0 + +### Minor Changes + +- [#2931](https://github.com/withastro/starlight/pull/2931) [`10b93b3`](https://github.com/withastro/starlight/commit/10b93b336cf4e3500e3003635b5afc430284d1a7) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds support for the `title`, `frame`, and `meta` fence attributes to code blocks. + + These new optional attributes add support for Expressive Code [text & line markers](https://expressive-code.com/key-features/text-markers/). The following example renders a code block using a [terminal frame](https://expressive-code.com/key-features/frames/#terminal-frames) with a [title](https://expressive-code.com/key-features/frames/#code-editor-frames): + + ````mdoc + ```js {% title="editor.exe" frame="terminal" %} + console.log('Hello, world!'); + ``` + ```` + + Any other text or line markers should be specified using the `meta` fence attribute. For example, the following code block renders a code block using the `diff` syntax combined with the `js` language syntax highlighting and the `markers` text highlighted: + + ````mdoc + ```diff {% meta="lang=js 'markers'" %} + function thisIsJavaScript() { + // This entire block gets highlighted as JavaScript, + // and we can still add diff markers to it! + - console.log('Old code to be removed') + + console.log('New and shiny code!') + } + ``` + ```` + + To learn more about all the available options, check out the [Expressive Code documentation](https://expressive-code.com/key-features/text-markers/#usage-in-markdown--mdx). + ## 0.2.0 ### Minor Changes diff --git a/packages/markdoc/package.json b/packages/markdoc/package.json index 77a14796..b8b11a2c 100644 --- a/packages/markdoc/package.json +++ b/packages/markdoc/package.json @@ -1,6 +1,6 @@ { "name": "@astrojs/starlight-markdoc", - "version": "0.2.0", + "version": "0.3.0", "description": "Markdoc preset for the Starlight documentation theme for Astro", "author": "Chris Swithinbank <swithinbank@gmail.com>", "license": "MIT", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index d52f7e9e..afc4ba8e 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -94,7 +94,7 @@ importers: specifier: ^0.32.2 version: link:../../packages/starlight '@astrojs/starlight-markdoc': - specifier: ^0.2.0 + specifier: ^0.3.0 version: link:../../packages/markdoc astro: specifier: ^5.1.5 |