@riebeckite/plugin-plantuml 0.0.20 → 0.0.22

package/README.md

@@ -1,5 +1,7 @@
 # @riebeckite/plugin-plantuml
 
+<!-- Generated from docs/docs/plugins/plantuml.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
+
 PlantUML diagram rendering for ` ```plantuml ` code blocks. Diagrams are turned into
 a PlantUML server image URL at build time; the build itself never talks to the
 network and no client JavaScript is shipped.
@@ -20,29 +22,35 @@ export default defineConfig({
 
 `plantuml` is also exported under the alias `plantumlPlugin`.
 
-## Behavior
-
-Each ` ```plantuml ` code block is replaced with a `figure.rb-plantuml` whose
-diagram is an `<img>` pointing at the PlantUML server.
-
-```html
-<figure class="rb-plantuml" data-plantuml data-plantuml-marker="..." data-plantuml-source="...">
-  <div class="rb-plantuml__frame">
-    <img class="rb-plantuml__image" src="https://www.plantuml.com/plantuml/svg/..." alt="..." loading="lazy" />
-  </div>
-  <details class="rb-plantuml__fallback">
-    <summary>Diagram source</summary>
-    <pre><code>...</code></pre>
-  </details>
-  <figcaption class="rb-plantuml__caption">...</figcaption>
-</figure>
+## Live example
+
+Each ` ```plantuml ` code block is rendered as a diagram on this page.
+
+#### Source
+
+````md
+```plantuml
+@startuml
+Alice -> Bob: Hello
+Bob --> Alice: Hi
+@enduml
 ```
+````
 
-The caption comes from the code block `title` or from a `%% caption: ...` line in
-the source. Because `%%` is not PlantUML comment syntax, the `%% caption:` line is
-removed from the diagram source before it is encoded. When there is no caption,
-the `<img>` alternative text is `PlantUML diagram`. With `fallback` enabled the
-original PlantUML source is kept in a collapsible `<details>` element.
+#### Rendered
+
+```plantuml
+@startuml
+Alice -> Bob: Hello
+Bob --> Alice: Hi
+@enduml
+```
+
+The caption comes from the code block `title` or from a `%% caption: ...` line
+in the source. Because `%%` is not PlantUML comment syntax, the `%% caption:`
+line is removed from the diagram source before it is encoded. When there is no
+caption, the image alternative text is `PlantUML diagram`. With `fallback`
+enabled the original PlantUML source is kept in a collapsible details element.
 
 ## URL encoding
 
@@ -97,5 +105,4 @@ Encoding failures are reported with `file.message(...)`. Diagnostics use
 
 ## See also
 
-- [Plugin guide](../../../docs/docs/reference/plugin-api.md)
-
+- [Plugin guide](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/reference/plugin-api.md)

package/README_ja.md

@@ -1,5 +1,7 @@
 # @riebeckite/plugin-plantuml
 
+<!-- Generated from docs/docs/plugins/plantuml.ja.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
+
 `plantuml` コードブロックを PlantUML の図として表示するプラグインです。ビルド時に PlantUML サーバーの画像 URL を組み立てるだけで、ビルド中にネットワークへアクセスしません。クライアント用の JavaScript も配布しません。
 
 [English](./README.md)
@@ -18,24 +20,35 @@ export default defineConfig({
 
 `plantuml` は `plantumlPlugin` という別名でもエクスポートしています。
 
-## どのように描画されるか
-
-` ```plantuml ` のコードブロックは `figure.rb-plantuml` に置き換わります。図そのものは `<img>` で、PlantUML サーバーが返す画像を指します。
-
-```html
-<figure class="rb-plantuml" data-plantuml data-plantuml-marker="..." data-plantuml-source="...">
-  <div class="rb-plantuml__frame">
-    <img class="rb-plantuml__image" src="https://www.plantuml.com/plantuml/svg/..." alt="..." loading="lazy" />
-  </div>
-  <details class="rb-plantuml__fallback">
-    <summary>Diagram source</summary>
-    <pre><code>...</code></pre>
-  </details>
-  <figcaption class="rb-plantuml__caption">...</figcaption>
-</figure>
+## 実行例
+
+` ```plantuml ` のコードブロックは、このページ上で図として実際に描画されます。
+
+#### ソース
+
+````md
+```plantuml
+@startuml
+Alice -> Bob: Hello
+Bob --> Alice: Hi
+@enduml
 ```
+````
 
-キャプションはコードブロックの `title`、またはソース中の `%% caption: ...` 行から取得します。`%%` は PlantUML のコメント記法ではないため、`%% caption:` 行は図のソースから取り除いてからエンコードします。キャプションがない場合、`<img>` の代替テキストは `PlantUML diagram` になります。`fallback` を有効にすると、元の PlantUML ソースを折りたたみ表示で残します。
+#### 実行例
+
+```plantuml
+@startuml
+Alice -> Bob: Hello
+Bob --> Alice: Hi
+@enduml
+```
+
+キャプションはコードブロックの `title`、またはソース中の `%% caption: ...` 行から取得
+します。`%%` は PlantUML のコメント記法ではないため、`%% caption:` 行は図のソースから
+取り除いてからエンコードします。キャプションがない場合、画像の代替テキストは
+`PlantUML diagram` になります。`fallback` を有効にすると、元の PlantUML ソースを
+折りたたみ表示で残します。
 
 ## URL のエンコード
 
@@ -78,5 +91,4 @@ export default defineConfig({
 
 ## 関連資料
 
-- [プラグインシステム](../../../docs/docs/reference/plugin-api.ja.md)
-
+- [プラグインシステム](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/reference/plugin-api.ja.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-plantuml",
-  "version": "0.0.20",
+  "version": "0.0.22",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -15,7 +15,7 @@
     "./style.css": "./style.css"
   },
   "dependencies": {
-    "@riebeckite/core": "0.0.20"
+    "@riebeckite/core": "0.0.22"
   },
   "publishConfig": {
     "access": "public"