前回markdown記法について記述しましたが、今回はその延長線上にあるmermaid記法を解説します。
markdown記法と同じように普通のメモ帳でも記述できる、特別なツールの要らない記法なのですが、それを正しく画面にが画像として表示するには何かしらツールが必要になります。
mermaid対応Webサイト
mermaid対応ローカルツール
Mermaidは、テキスト形式で様々な図(ダイヤグラム)を描画できるツールです。Markdownファイル内に ```mermaid```で囲むことで直接レンダリングされます。
---
1. 基本的な書き方
概要
Mermaidを描画するには、Markdownのコードブロック構文を使用し、言語指定に mermaid と記述します。1行目に図の種類(キーワード)を指定し、2行目以降に要素と接続関係を記述します。
サンプル
``` mermaid
flowchart LR
A[開始] --> B[処理]
B --> C[終了]
```
2. フローチャート (Flowchart)
概要
処理の流れやシステムのプロセスを可視化します。方向指定(TD: 上から下、LR: 左から右など)やノードの形状([]: 四角、(): 丸角、{}: ひし形など)を指定できます。
サンプル
``` mermaid
flowchart TD
Start([開始]) --> Input[/データを入力/]
Input --> Check{データは正しいか?}
Check -- Yes --> Process[処理を実行]
Check -- No --> Error[エラーを表示]
Process --> End([終了])
Error --> End
```
3. 実体関連図 (Entity Relationship Diagram)
概要
データベースのテーブル構造やリレーションシップ(1対1、1対多、多対多など)を定義・可視化します。エンティティ名、属性名、データ型、カーディナリティ(記号による対応関係)を記述します。
サンプル
``` mermaid
erDiagram
USERS ||--o{ ORDERS : "place"
ORDERS ||--|{ ORDER_ITEMS : "contains"
PRODUCTS ||--o{ ORDER_ITEMS : "included in"
USERS {
int id PK
string name
string email
}
ORDERS {
int id PK
int user_id FK
date order_date
}
PRODUCTS {
int id PK
string name
int price
}
```
4. クラス図 (Class Diagram)
概要
オブジェクト指向プログラミングのクラス構造、属性、メソッド、およびクラス間の関係(継承、依存、関連など)を視覚化します。
サンプル
``` mermaid
classDiagram
class Animal {
+String name
+int age
+makeSound() void
}
class Dog {
+String breed
+bark() void
}
class Cat {
+purple eyeColor
+meow() void
}
Animal <|-- Dog : 継承
Animal <|-- Cat : 継承
```
5. ガントチャート (Gantt)
概要
プロジェクトのスケジュールやタスクの進捗状況をタイムライン形式で表現します。セクション分け、タスクの期間、依存関係(after)などを指定できます。
サンプル
``` mermaid
gantt
title プロジェクト開発スケジュール
dateFormat YYYY-MM-DD
section 設計フェーズ
要件定義 :a1, 2026-11-01, 7d
詳細設計 :a2, after a1, 10d
section 開発フェーズ
フロントエンド開発 :2026-11-18, 14d
バックエンド開発 :2026-11-18, 14d
section テストフェーズ
結合テスト :after a2, 7d
```
6. マインドマップ (Mindmap)
概要
中心となるアイデアから関連するトピックを放射状に広げていくブレインストーミング用の図です。インデント(タブまたはスペース)で階層構造を表現します。
サンプル
``` mermaid
mindmap
root((Web開発))
フロントエンド
HTML / CSS
JavaScript
React
バックエンド
Python
Node.js
データベース
PostgreSQL
MongoDB
インフラ
Docker
AWS
```
7. シーケンス図 (Sequence Diagram)
概要
システムやコンポーネント間でやり取りされるメッセージの時系列順のやり取りを可視化します。アクター、オブジェクト、呼び出し(->>)、応答(-->>)などを記述します。
サンプル
``` mermaid
sequenceDiagram
autonumber
actor User as ユーザー
participant Client as ブラウザ
participant Server as サーバー
participant DB as データベース
User->>Client: ログイン情報を入力
Client->>Server: POST /login
Server->>DB: ユーザー情報を照会
DB-->>Server: ユーザーデータ返却
Server-->>Client: 認証成功 (JWT発行)
Client-->>User: マイページへ遷移
```
8. 状態遷移図 (State Diagram)
概要
システムやオブジェクトが取る状態(State)と、イベントによって状態がどのように移り変わるか(Transition)を表現します。初期状態([*])および終了状態を明記できます。
サンプル
``` mermaid
stateDiagram-v2
[*] --> Idle
Idle --> Processing : ボタン押下
Processing --> Success : 処理成功
Processing --> Error : 処理失敗
Error --> Idle : リトライ
Success --> [*]
```