@riebeckite/plugin-hard-breaks 0.0.32 → 0.0.33

package/README.md

@@ -64,6 +64,16 @@ With `hardBreaks()`:
 明日も晴れるといいな。</p>
 ```
 
+## Live example
+
+`hardBreaks()` is opt-in, so this site keeps the standard Markdown behavior: the three lines below render as one paragraph.
+
+First line
+Second line
+Third line
+
+With the plugin enabled, each line ends with `<br>` instead.
+
 ## Behavior
 
 | Input | Result |
@@ -94,7 +104,7 @@ Riebeckite's rendered pages.
 ## Exports
 
 - `hardBreaks()` — plugin factory
-- `hardBreaksPlugin` — alias of `hardBreaks`
+- `hardBreaks` — alias of `hardBreaks`
 
 ## See also
 

package/README_ja.md

@@ -11,12 +11,11 @@ Markdown の通常の改行を `<br>` 要素として出力するプラグイン
 
 標準の Markdown では、段落内の単一の改行はソフトブレークとなり、空白として
 描画されます。`hardBreaks()` は
-[`remark-breaks`](https://github.com/remarkjs/remark-breaks) のトランス
-フォーマーを Riebeckite の Markdown パイプラインに登録し、ソフトブレークを
-ビルド時に `<br>` 要素へ変換します。
+[`remark-breaks`](https://github.com/remarkjs/remark-breaks) のトランスフォーマーを Riebeckite の Markdown
+パイプラインに登録し、ソフトブレークをビルド時に `<br>` 要素へ変換します。
 
 変換は Markdown AST の段階で行われるため、コードブロック、インラインコード、
-明示的な hard break の意味は変わりません。クライアント JavaScript と CSS は
+明示的なハードブレークの意味は変わりません。クライアント側の JavaScript と CSS は
 追加しません。
 
 ## インストール
@@ -32,7 +31,7 @@ export default defineConfig({
 ```
 
 `riebeckite.config.ts` の `plugins` 配列に `hardBreaks()` を追加します。この
-プラグインは opt-in です。追加しない場合、パイプラインは標準の Markdown の
+プラグインはオプトインです。追加しない場合、パイプラインは標準の Markdown の
 ソフトブレークの挙動を維持します。
 
 ## 使い方
@@ -64,18 +63,28 @@ hardBreaks();
 明日も晴れるといいな。</p>
 ```
 
+## 実行例
+
+`hardBreaks()` は opt-in なので、このサイトでは標準の Markdown の挙動のままです。次の 3 行は 1 つの段落として描画されます。
+
+1 行目
+2 行目
+3 行目
+
+プラグインを有効にすると、各行の末尾に `<br>` が入ります。
+
 ## 動作仕様
 
 | 入力 | 動作 |
 | --- | --- |
 | 段落内の単一の改行 | `<br>` に変換する |
 | 空行による段落の分割 | 従来どおり段落を分割する |
-| Fenced code block | 変更しない |
+| フェンス付きコードブロック | 変更しない |
 | インラインコード | 変更しない |
 | 見出し | Markdown の見出し構造を維持する |
 | リスト項目内の改行 | Markdown AST の構造に従って処理する |
-| Blockquote 内の改行 | 通常の段落と同様に処理する |
-| 明示的な hard break（行末の空白 2 つ、または `\`） | 二重変換しない |
+| 引用内の改行 | 通常の段落と同様に処理する |
+| 明示的なハードブレーク（行末の空白 2 つ、または `\`） | 二重変換しない |
 | Markdown 内の HTML | そのまま扱う |
 
 ## 制約事項
@@ -93,7 +102,7 @@ Obsidian には「厳密な改行」という設定があります。これを
 ## 主なエクスポート
 
 - `hardBreaks()`: プラグインを作成する
-- `hardBreaksPlugin`: `hardBreaks` の別名
+- `hardBreaks`: `hardBreaks` の別名
 
 ## 関連資料
 

package/dist/index.d.ts

@@ -1,3 +1 @@
 export declare function hardBreaks(): import("@riebeckite/core").RiebeckitePlugin<unknown>;
-/** Alias kept for parity with plugins that export a `…Plugin` factory. */
-export declare const hardBreaksPlugin: typeof hardBreaks;

package/dist/index.js

@@ -11,8 +11,6 @@ function hardBreaks() {
     remarkPlugins: [remarkBreaks]
   });
 }
-var hardBreaksPlugin = hardBreaks;
 export {
-  hardBreaks,
-  hardBreaksPlugin
+  hardBreaks
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-hard-breaks",
-  "version": "0.0.32",
+  "version": "0.0.33",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -14,12 +14,12 @@
     }
   },
   "dependencies": {
-    "remark-breaks": "^4.0.0",
-    "@riebeckite/core": "0.0.32"
+    "@riebeckite/core": "0.0.33",
+    "remark-breaks": "^4.0.0"
   },
   "devDependencies": {
-    "tsx": "^4.22.4",
-    "@riebeckite/test": "0.0.32"
+    "@riebeckite/test": "0.0.33",
+    "tsx": "^4.22.4"
   },
   "publishConfig": {
     "access": "public"