@riebeckite/plugin-code-enhance 0.0.32 → 0.0.33

package/README.md

@@ -35,6 +35,16 @@ export default defineConfig({
 });
 ```
 
+## Live example
+
+The block below uses a filename header, line numbers, and a highlighted line.
+
+~~~ts title="greeting.ts" {2}
+export function greet(name: string) {
+  return `Hello, ${name}`;
+}
+~~~
+
 ## Features
 
 - Syntax highlighting via Shiki (rehype-pretty-code)

package/README_ja.md

@@ -2,7 +2,7 @@
 
 <!-- Generated from docs/docs/plugins/code-enhance.ja.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
 
-Shiki によるシンタックスハイライトへ、コピー、折り返し、折りたたみなどの操作を加えるプラグインです。
+Shiki のシンタックスハイライトに、ファイル名ヘッダーとコピー、折り返し、折りたたみの操作を加えたコードブロックを提供するプラグインです。
 
 [English](./README.md)
 
@@ -20,6 +20,16 @@ export default defineConfig({
 
 `codeEnhance()` は `rehype-pretty-code` を使ってコードブロックを処理し、ファイル名と操作ボタンを持つ `.rr-code` 要素に整えます。ボタンの操作はクライアントエントリーが担当します。
 
+## 実行例
+
+次のブロックでは、ファイル名ヘッダー、行番号、行ハイライトを同時に使っています。
+
+~~~ts title="greeting.ts" {2}
+export function greet(name: string) {
+  return `Hello, ${name}`;
+}
+~~~
+
 ## 表示と操作
 
 - Shiki のテーマによる色付け、行番号、メタデータによる行・文字の強調
@@ -29,7 +39,7 @@ export default defineConfig({
 - `bash`、`console`、`sh` などのシェル言語の行に `$` を付ける
 - キーボードで内容を確認できるよう、`<pre>` をフォーカス可能にする
 
-Theme は `rr-code` の root に `--rr-code-syntax` を指定すると、ハイライト済みコードの
+テーマは `rr-code` のルート要素に `--rr-code-syntax` を指定すると、ハイライト済みコードの
 子要素を選択せずに構文色を指定できます。
 
 ## オプション
@@ -51,12 +61,12 @@ Theme は `rr-code` の root に `--rr-code-syntax` を指定すると、ハイ
 
 ## クライアント側の初期化
 
-`codeEnhance()` は `copyLabel` と `copiedLabel` をクライアントエントリーへ渡します。`initCodeEnhance(options?)` はコピー、折り返し、折りたたみボタンのために document 全体のクリックハンドラーを登録します。直接呼び出す場合も同じ二つの文言を指定できます。
+`codeEnhance()` は `copyLabel` と `copiedLabel` をクライアントエントリーへ渡します。`initCodeEnhance(options?)` はコピー、折り返し、折りたたみボタンのためにドキュメント全体のクリックハンドラーを登録します。直接呼び出す場合も同じ 2 つの文言を指定できます。
 
 ## 公開 API
 
 - `codeEnhance(options?)`：プラグインファクトリ
-- `rehypeCodeEnhance(options?)`：Rehype 変換
+- `rehypeCodeEnhance(options?)`：rehype 変換
 - `initCodeEnhance(options?)`：ブラウザ初期化関数
 - `DEFAULT_COPY_LABEL`、`DEFAULT_COPIED_LABEL`：既定のコピー文言
 - `CodeEnhanceOptions`、`CodeEnhanceClientOptions`、`CodeEnhanceTheme`：型

package/dist/src/hast.d.ts

@@ -1,6 +1,5 @@
 import type { ElementNode, HastNode, TextNode } from "./types.js";
 export declare function visitElements(node: HastNode, visitor: (node: ElementNode, parent?: ElementNode, index?: number) => void, parent?: ElementNode, index?: number): void;
-export declare function isElementNode(node: HastNode): node is ElementNode;
 export declare function text(value: string): TextNode;
 export declare function element(tagName: string, properties?: Record<string, unknown>, children?: HastNode[]): ElementNode;
 export declare function getStringProperty(node: ElementNode, key: string): string | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-code-enhance",
-  "version": "0.0.32",
+  "version": "0.0.33",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -21,9 +21,9 @@
     "./style.css": "./style.css"
   },
   "dependencies": {
+    "@riebeckite/core": "0.0.33",
     "rehype-pretty-code": "^0.14.1",
-    "shiki": "^3.13.0",
-    "@riebeckite/core": "0.0.32"
+    "shiki": "^3.13.0"
   },
   "devDependencies": {
     "tsx": "^4.22.4"