@riebeckite/plugin-highlight 0.0.11 → 0.0.13

package/README.md

@@ -1,91 +1,91 @@
-# @riebeckite/plugin-highlight
-
-Inline `==highlight==` support. Text wrapped in double equals is rendered as a
-`<mark>` element at build time.
-
-[日本語](./README_ja.md)
-
-## Overview
-
-`highlight()` registers a remark transformer that rewrites `==text==` in
-Markdown text nodes into raw HTML before the tree is converted to HTML. It
-complements `remark-gfm` (which only understands `~~strikethrough~~`).
-
-## Usage
-
-```ts
-import { defineConfig } from "@riebeckite/core";
-import { highlight } from "@riebeckite/plugin-highlight";
-
-export default defineConfig({
-  // ...
-  plugins: [highlight()],
-});
-```
-
-## Syntax
-
-```md
-This sentence has a ==highlighted phrase== inside it.
-```
-
-Output:
-
-```html
-This sentence has a <mark class="rb-highlight">highlighted phrase</mark> inside it.
-```
-
-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.
-
-## Options
-
-| Option | Type | Default | Description |
-| ------ | ---- | ------- | ----------- |
-| `className` | `string` | `"rb-highlight"` | CSS class on each generated element |
-| `tag` | `string` | `"mark"` | HTML tag used for the highlight |
-
-```ts
-highlight({ className: "my-highlight", tag: "span" });
-```
-
-## Styling
-
-The package ships `style.css`, exposed as
-`@riebeckite/plugin-highlight/style.css`. The default rule styles
-`.rb-highlight` with a subtle accent background and falls back to the
-`--rb-color-accent` theme variable when available:
-
-```css
-.rb-highlight {
-  --rb-highlight-accent: var(--rb-color-accent, #f6d365);
-  padding: 0.05em 0.25em;
-  border-radius: 0.2em;
-  background: color-mix(in srgb, var(--rb-highlight-accent) 45%, transparent);
-  color: inherit;
-}
-```
-
-Because the plugin registers a style asset, the host site includes this
-stylesheet automatically; override the class or supply your own CSS to change
-the appearance.
-
-## Limitations
-
-- A highlight never spans multiple text nodes or lines, so `==` delimiters
-  cannot wrap other Markdown (links, emphasis, code) or line breaks.
-- Nested highlights are not supported; the innermost `==` pair wins.
-- The transformer emits raw HTML, so enable raw HTML output in the pipeline
-  (the default Riebeckite pipeline does).
-
-## Exports
-
-- `highlight(options?)` — plugin factory
-- `highlightPlugin` — alias of `highlight`
-- `remarkHighlight(options?)` — the underlying remark transformer
-- Type: `HighlightOptions`
-
-## See also
-
-- [Plugin guide](../../../docs/en/plugin-system.md)
+# @riebeckite/plugin-highlight
+
+Inline `==highlight==` support. Text wrapped in double equals is rendered as a
+`<mark>` element at build time.
+
+[日本語](./README_ja.md)
+
+## Overview
+
+`highlight()` registers a remark transformer that rewrites `==text==` in
+Markdown text nodes into raw HTML before the tree is converted to HTML. It
+complements `remark-gfm` (which only understands `~~strikethrough~~`).
+
+## Usage
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { highlight } from "@riebeckite/plugin-highlight";
+
+export default defineConfig({
+  // ...
+  plugins: [highlight()],
+});
+```
+
+## Syntax
+
+```md
+This sentence has a ==highlighted phrase== inside it.
+```
+
+Output:
+
+```html
+This sentence has a <mark class="rb-highlight">highlighted phrase</mark> inside it.
+```
+
+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.
+
+## Options
+
+| Option | Type | Default | Description |
+| ------ | ---- | ------- | ----------- |
+| `className` | `string` | `"rb-highlight"` | CSS class on each generated element |
+| `tag` | `string` | `"mark"` | HTML tag used for the highlight |
+
+```ts
+highlight({ className: "my-highlight", tag: "span" });
+```
+
+## Styling
+
+The package ships `style.css`, exposed as
+`@riebeckite/plugin-highlight/style.css`. The default rule styles
+`.rb-highlight` with a subtle accent background and falls back to the
+`--rb-color-accent` theme variable when available:
+
+```css
+.rb-highlight {
+  --rb-highlight-accent: var(--rb-color-accent, #f6d365);
+  padding: 0.05em 0.25em;
+  border-radius: 0.2em;
+  background: color-mix(in srgb, var(--rb-highlight-accent) 45%, transparent);
+  color: inherit;
+}
+```
+
+Because the plugin registers a style asset, the host site includes this
+stylesheet automatically; override the class or supply your own CSS to change
+the appearance.
+
+## Limitations
+
+- A highlight never spans multiple text nodes or lines, so `==` delimiters
+  cannot wrap other Markdown (links, emphasis, code) or line breaks.
+- Nested highlights are not supported; the innermost `==` pair wins.
+- The transformer emits raw HTML, so enable raw HTML output in the pipeline
+  (the default Riebeckite pipeline does).
+
+## Exports
+
+- `highlight(options?)` — plugin factory
+- `highlightPlugin` — alias of `highlight`
+- `remarkHighlight(options?)` — the underlying remark transformer
+- Type: `HighlightOptions`
+
+## See also
+
+- [Plugin guide](../../../docs/en/reference/plugin-api.md)

package/README_ja.md

@@ -1,91 +1,91 @@
-# @riebeckite/plugin-highlight
-
-`==ハイライト==` を `<mark>` 要素として表示するプラグインです。Markdown の
-テキストノードをビルド時に書き換えます。
-
-[English](./README.md)
-
-## 概要
-
-`highlight()` は、Markdown のテキストノードにある `==テキスト==` を HTML に
-変換する前に生の HTML へ置き換える remark トランスフォーマーを登録します。
-`~~打ち消し線~~` だけを扱う `remark-gfm` を補完します。
-
-## 設定する
-
-```ts
-import { defineConfig } from "@riebeckite/core";
-import { highlight } from "@riebeckite/plugin-highlight";
-
-export default defineConfig({
-  // ...
-  plugins: [highlight()],
-});
-```
-
-## 構文
-
-```md
-この文には ==ハイライトする語句== が含まれます。
-```
-
-出力:
-
-```html
-この文には <mark class="rb-highlight">ハイライトする語句</mark> が含まれます。
-```
-
-ハイライトは非貪欲に一致し、改行をまたぎません。空、または空白だけの
-ハイライトは無視します。コードブロック、インラインコード、生の HTML、
-フロントマターの内部は変更しません。
-
-## オプション
-
-| 項目 | 型 | 既定値 | 説明 |
-| --- | --- | --- | --- |
-| `className` | `string` | `"rb-highlight"` | 生成する要素に付ける CSS クラス |
-| `tag` | `string` | `"mark"` | ハイライトに使う HTML タグ |
-
-```ts
-highlight({ className: "my-highlight", tag: "span" });
-```
-
-## スタイル
-
-このパッケージは `style.css` を同梱し、
-`@riebeckite/plugin-highlight/style.css` として公開します。既定のルールは
-`.rb-highlight` に控えめなアクセント背景を付け、テーマ変数
-`--rb-color-accent` があればそれを使います。
-
-```css
-.rb-highlight {
-  --rb-highlight-accent: var(--rb-color-accent, #f6d365);
-  padding: 0.05em 0.25em;
-  border-radius: 0.2em;
-  background: color-mix(in srgb, var(--rb-highlight-accent) 45%, transparent);
-  color: inherit;
-}
-```
-
-プラグインはスタイルアセットを登録するため、ホスト側のサイトはこの
-スタイルシートを自動的に取り込みます。見た目を変えたい場合はクラスを指定する
-か、独自の CSS で上書きしてください。
-
-## 制限
-
-- ハイライトは複数のテキストノードや行をまたげません。`==` で他の Markdown
-  (リンク、強調、コード) や改行を囲むことはできません。
-- 入れ子のハイライトには対応しません。最も内側の `==` の組が優先されます。
-- 生の HTML を出力するため、パイプラインで生 HTML の出力を有効にする必要が
-  あります（Riebeckite の既定パイプラインでは有効です）。
-
-## 主なエクスポート
-
-- `highlight(options?)`: プラグインを作成する
-- `highlightPlugin`: `highlight` の別名
-- `remarkHighlight(options?)`: 内部の remark トランスフォーマー
-- 型: `HighlightOptions`
-
-## 関連資料
-
-- [プラグインガイド](../../../docs/ja/plugin-system.md)
+# @riebeckite/plugin-highlight
+
+`==ハイライト==` を `<mark>` 要素として表示するプラグインです。Markdown の
+テキストノードをビルド時に書き換えます。
+
+[English](./README.md)
+
+## 概要
+
+`highlight()` は、Markdown のテキストノードにある `==テキスト==` を HTML に
+変換する前に生の HTML へ置き換える remark トランスフォーマーを登録します。
+`~~打ち消し線~~` だけを扱う `remark-gfm` を補完します。
+
+## 設定する
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { highlight } from "@riebeckite/plugin-highlight";
+
+export default defineConfig({
+  // ...
+  plugins: [highlight()],
+});
+```
+
+## 構文
+
+```md
+この文には ==ハイライトする語句== が含まれます。
+```
+
+出力:
+
+```html
+この文には <mark class="rb-highlight">ハイライトする語句</mark> が含まれます。
+```
+
+ハイライトは非貪欲に一致し、改行をまたぎません。空、または空白だけの
+ハイライトは無視します。コードブロック、インラインコード、生の HTML、
+フロントマターの内部は変更しません。
+
+## オプション
+
+| 項目 | 型 | 既定値 | 説明 |
+| --- | --- | --- | --- |
+| `className` | `string` | `"rb-highlight"` | 生成する要素に付ける CSS クラス |
+| `tag` | `string` | `"mark"` | ハイライトに使う HTML タグ |
+
+```ts
+highlight({ className: "my-highlight", tag: "span" });
+```
+
+## スタイル
+
+このパッケージは `style.css` を同梱し、
+`@riebeckite/plugin-highlight/style.css` として公開します。既定のルールは
+`.rb-highlight` に控えめなアクセント背景を付け、テーマ変数
+`--rb-color-accent` があればそれを使います。
+
+```css
+.rb-highlight {
+  --rb-highlight-accent: var(--rb-color-accent, #f6d365);
+  padding: 0.05em 0.25em;
+  border-radius: 0.2em;
+  background: color-mix(in srgb, var(--rb-highlight-accent) 45%, transparent);
+  color: inherit;
+}
+```
+
+プラグインはスタイルアセットを登録するため、ホスト側のサイトはこの
+スタイルシートを自動的に取り込みます。見た目を変えたい場合はクラスを指定する
+か、独自の CSS で上書きしてください。
+
+## 制限
+
+- ハイライトは複数のテキストノードや行をまたげません。`==` で他の Markdown
+  (リンク、強調、コード) や改行を囲むことはできません。
+- 入れ子のハイライトには対応しません。最も内側の `==` の組が優先されます。
+- 生の HTML を出力するため、パイプラインで生 HTML の出力を有効にする必要が
+  あります（Riebeckite の既定パイプラインでは有効です）。
+
+## 主なエクスポート
+
+- `highlight(options?)`: プラグインを作成する
+- `highlightPlugin`: `highlight` の別名
+- `remarkHighlight(options?)`: 内部の remark トランスフォーマー
+- 型: `HighlightOptions`
+
+## 関連資料
+
+- [プラグインガイド](../../../docs/ja/reference/plugin-api.md)

package/package.json

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