Riebeckite
Menu
Color mode

Mermaid

Mermaid のコードブロックを図として表示する Plugin です。フローチャートなどを Markdown 内に記述できます。

導入

bash
npm install @riebeckite/plugin-mermaid

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

使用例

記事内に Mermaid のコードブロックを書くと、その場で図として表示できます。

ソース

markdown
```mermaid
graph LR
  A[Markdown] --> B[Riebeckite]
  B --> C[Web site]
```

実行例

Diagram source
text
graph LR
  A[Markdown] --> B[Riebeckite]
  B --> C[Web site]

使いどころ

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

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

詳細仕様

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

History

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