Mermaid の使い方:フローチャート・シーケンス図・ガントチャート

Mermaid は「図をテキストで記述する」ための記法です。図形をドラッグしたり画像ファイルを管理したりする必要はなく、Markdown に数行書くだけでビューアが図を描いてくれます。テキストなので修正しやすく、バージョン管理とも相性抜群。GitHub、GitLab、Notion、そして Moread が対応しています。

Markdown に Mermaid を書く方法

バッククォート 3 つでコードブロックを作り、言語名に mermaid を指定します。

```mermaid
flowchart LR
    A[開始] --> B[終了]
```

これを .md ファイルに書いて Moread で開くと、左から右へ流れるフローチャートが表示されます。図の右上の「拡大表示」で細部を確認できます。

フローチャート

1 行目で向きを指定します。TD(上から下)または LR(左から右)です。括弧の種類でノードの形が変わります。

flowchart TD
    A[四角] --> B(角丸)
    B --> C{分岐}
    C -->|はい| D[[サブルーチン]]
    C -->|いいえ| E((円))
  • --> は矢印、--- は矢印なしの線、-.-> は点線の矢印です。
  • |文字| を矢印に付けると、条件などのラベルになります。
  • ノード ID(A、B、C)は重複しなければ何でもかまいません。表示されるのは括弧内の文字です。

シーケンス図

ユーザーとシステム、サービス同士のやりとりの順序を表すのに最適です。

sequenceDiagram
    participant U as ユーザー
    participant S as サーバー
    U->>S: ログイン情報を送信
    S-->>U: 結果を返す
    Note over U,S: 通信はすべて HTTPS

->> は実線の矢印(リクエスト)、-->> は点線の矢印(レスポンス)です。Note over で注釈を付けられます。

ガントチャート

プロジェクトのスケジュールがひと目でわかります。

gantt
    title Web サイトのリニューアル
    dateFormat YYYY-MM-DD
    section 設計
    ヒアリング :a1, 2025-01-06, 5d
    UI デザイン :after a1, 7d
    section 開発
    フロントエンド :2025-01-20, 10d
    テストと公開 :5d

円グラフ

pie title 1 日の時間配分
    "仕事" : 8
    "睡眠" : 7
    "読書" : 2
    "その他" : 7

状態遷移図

stateDiagram-v2
    [*] --> 下書き
    下書き --> レビュー中: 提出
    レビュー中 --> 公開済み: 承認
    レビュー中 --> 下書き: 差し戻し
    公開済み --> [*]

よくあるエラーと対処

  • 図が表示されない:コードブロックの言語が mermaid になっているか、1 行目に図の種類(flowchart、sequenceDiagram など)があるか確認してください。
  • ラベルに記号を含む:括弧やコロンを含むラベルはダブルクォートで囲みます。例:A["価格 (税込)"]
  • 向きの指定ミス:flowchart のあとに書けるのは TB、TD、BT、RL、LR だけです。
  • Moread は図にエラーがあってもソースを残して原因を表示し、文書のほかの部分は通常どおり表示します。

ちょっとしたコツ

  • 大きな図は LR 方向にすると読みやすくなることが多いです。
  • 1 つの文書に複数の図を入れられます。Moread は 1 ファイルあたり 40 個まで描画します。
  • ダークテーマでは図の配色も変わり、PDF 出力時は印刷向けの明るい配色になります。

実際に見てみたい方は、Moread のトップページで「図・数式・コード実行のデモ」を押すと、Mermaid の図を含むサンプル文書が開きます。