@riebeckite/plugin-highlight 0.0.31 → 0.0.33

package/README.md

@@ -41,6 +41,10 @@ Highlights are matched non-greedily, must stay on a single line, and are
 ignored when they are empty or contain only whitespace. Matches inside code
 blocks, inline code, raw HTML, and frontmatter are left untouched.
 
+## Live example
+
+A sentence with an ==emphasized phrase== and a second ==highlight==.
+
 ## Options
 
 | Option | Type | Default | Description |
@@ -84,7 +88,7 @@ the appearance.
 ## Exports
 
 - `highlight(options?)` — plugin factory
-- `highlightPlugin` — alias of `highlight`
+- `highlight` — alias of `highlight`
 - `remarkHighlight(options?)` — the underlying remark transformer
 - Type: `HighlightOptions`
 

package/README_ja.md

@@ -9,11 +9,11 @@
 
 ## 概要
 
-`highlight()` は、Markdown のテキストノードにある `==テキスト==` を HTML に
+`highlight()` は、Markdown のテキストノードにある `==テキスト==` を、HTML へ
 変換する前に生の HTML へ置き換える remark トランスフォーマーを登録します。
-`~~打ち消し線~~` だけを扱う `remark-gfm` を補完します。
+`~~打ち消し線~~` しか扱わない `remark-gfm` を補います。
 
-## 設定する
+## 使い方
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
@@ -37,10 +37,14 @@ export default defineConfig({
 この文には <mark class="rb-highlight">ハイライトする語句</mark> が含まれます。
 ```
 
-ハイライトは非貪欲に一致し、改行をまたぎません。空、または空白だけの
+ハイライトは最短一致で、改行をまたぎません。空、または空白だけの
 ハイライトは無視します。コードブロック、インラインコード、生の HTML、
 frontmatter の内部は変更しません。
 
+## 実行例
+
+文中の ==強調したい語句== と、もう 1 つの ==ハイライト== がこのように表示されます。
+
 ## オプション
 
 | 項目 | 型 | 既定値 | 説明 |
@@ -84,7 +88,7 @@ highlight({ className: "my-highlight", tag: "span" });
 ## 主なエクスポート
 
 - `highlight(options?)`: プラグインを作成する
-- `highlightPlugin`: `highlight` の別名
+- `highlight`: `highlight` の別名
 - `remarkHighlight(options?)`: 内部の remark トランスフォーマー
 - 型: `HighlightOptions`
 

package/dist/index.d.ts

@@ -2,5 +2,3 @@ import type { HighlightOptions } from "./src/types.js";
 export { remarkHighlight } from "./src/remark.js";
 export type { HighlightOptions } from "./src/types.js";
 export declare function highlight(options?: HighlightOptions): import("@riebeckite/core").RiebeckitePlugin<HighlightOptions>;
-/** Alias kept for parity with plugins that export a `…Plugin` factory. */
-export declare const highlightPlugin: typeof highlight;

package/dist/index.js

@@ -87,7 +87,6 @@ function highlight(options = {}) {
     ]
   });
 }
-var highlightPlugin = highlight;
 function validateHighlightOptions(options) {
   if (!options) return [];
   const issues = [];
@@ -104,6 +103,5 @@ function validateHighlightOptions(options) {
 }
 export {
   highlight,
-  highlightPlugin,
   remarkHighlight
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-highlight",
-  "version": "0.0.31",
+  "version": "0.0.33",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -15,13 +15,13 @@
     "./style.css": "./style.css"
   },
   "dependencies": {
+    "@riebeckite/core": "0.0.33",
     "@types/mdast": "^4.0.4",
-    "unist-util-visit": "^5.1.0",
-    "@riebeckite/core": "0.0.31"
+    "unist-util-visit": "^5.1.0"
   },
   "devDependencies": {
-    "tsx": "^4.22.4",
-    "@riebeckite/test": "0.0.31"
+    "@riebeckite/test": "0.0.33",
+    "tsx": "^4.22.4"
   },
   "publishConfig": {
     "access": "public"