マークダウンの描画プラグインMermaidの使い方

2年 ago
蓮, 翼
1 minute

Markdown描画プラグインMermaidを使うには、以下の手順があります。

  1. マークダウンエディタでMermaidプラグインを検索し、ブラウザまたはエディタにインストールします。Typora、VS Codeなどの一般的なエディタはMermaidプラグインに対応しています。
  2. Markdown文書にMermaid構文を用いてグラフを定義：Mermaid構文をMarkdown文書に記載することで、グラフ作成時に必要な情報を指定します。Mermaidではフローチャートやシーケンス図、ガントチャートなど、さまざまな種類のグラフに対応しています。
  3. マークダウン文書内でグラフの構造や内容を記述するためにマーメイド記法を使用します。マーメイド記法は比較的単純なので、マーメイド記法の書き方が学べるマーメイド公式サイトのドキュメントやチュートリアルを参照してください。
  4. MarkdownドキュメントをMarkdownエディタでプレビューしたり、MarkdownドキュメントをHTMLやPDFなどの他の形式にエクスポートして、生成されたチャートを確認することができます。

以下に、Markdown で Mermaid を利用してフローチャートを描画する方法の簡単な例を示します。

graph LR
    A[开始] -- 进行中 --> B(处理中)
    B -- 完成 --> C{结束}
    C -- 是 --> D(成功)
    C -- 否 --> E(失败)
    D --> F[成功]
    E --> F

上のような手順を踏むことで、MarkdownドキュメントでMermaidのプラグインを使用して図表を描画することができます。ただし、さまざまなMarkdownエディタではMermaidのサポートレベルが異なるため、使い方には差異が生じる可能性があります。より詳しい情報については、該当するエディタのドキュメントやチュートリアルを参照することをお勧めします。

bannerAds