Riebeckite
Menu
Color mode

Graphviz

Graphviz / DOT のコードブロックを図として表示する Plugin です。

導入

bash
npm install @riebeckite/plugin-graphviz

Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は riebeckite.config.ts の plugins に登録して利用します。

使用例

Graphviz の DOT 記法で、依存関係や状態遷移などの図を記事内に記述できます。

ソース

markdown
```dot
digraph G {
  Markdown -> Riebeckite;
  Riebeckite -> Web;
}
```

実行例

Diagram source
text
digraph G {
  Markdown -> Riebeckite;
  Riebeckite -> Web;
}

使いどころ

この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。

実際の表示例が用意されている場合は、Plugin Showcase でも確認できます。

詳細仕様

設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは Plugin System、Plugin を作る場合は Writing a Plugin を参照してください。

History

1 changesCollapseExpand
1 + # Graphviz
2 +
3 + Graphviz / DOT のコードブロックを図として表示する Plugin です。
4 +
5 + ## 導入
6 +
7 + ```bash
8 + npm install @riebeckite/plugin-graphviz
9 + ```
10 +
11 + Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は `riebeckite.config.ts` の `plugins` に登録して利用します。
12 +
13 + ## 使用例
14 +
15 + Graphviz の DOT 記法で、依存関係や状態遷移などの図を記事内に記述できます。
16 +
17 + ### ソース
18 +
19 + ````markdown
20 + ```dot
21 + digraph G {
22 + Markdown -> Riebeckite;
23 + Riebeckite -> Web;
24 + }
25 + ```
26 + ````
27 +
28 + ### 実行例
29 +
30 + ```dot
31 + digraph G {
32 + Markdown -> Riebeckite;
33 + Riebeckite -> Web;
34 + }
35 + ```
36 +
37 + ## 使いどころ
38 +
39 + この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。
40 +
41 + 実際の表示例が用意されている場合は、[Plugin Showcase](./showcase.md) でも確認できます。
42 +
43 + ## 詳細仕様
44 +
45 + 設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは [Plugin System](../framework/plugin-system.md)、Plugin を作る場合は [Writing a Plugin](./writing-a-plugin.md) を参照してください。
46 +
47 +