読み方 : マーメイド
Mermaid
Mermaidとは?
決められた書式で文字データを記述するだけで図表を自動生成できる、軽量なダイアグラム記述言語。JavaScriptで実装されており、Webブラウザ上でリアルタイムに図として描画される。

従来、フローチャートや設計図を作成するには「Visio」や「draw.io」のような専用ツールを使い、マウスで図形を配置・接続する作業が必要だった。Mermaidではその作業をテキストで代替できる。フローチャートであれば「graph TD」と書き出し、「A --> B」のように矢印でノード間の関係を記述するだけで図が完成する。文章を編集する感覚で図を修正できるため、内容変更への対応も容易である。
対応する図の種類はフローチャート、シーケンス図、ガントチャート、クラス図、状態遷移図、円グラフ、ER図など様々である。テキスト形式で保存されるため、Gitなどのバージョン管理システムで差分管理できる。画像ファイルでは変更箇所の比較が難しいが、Mermaidであればどの行が書き換えられたか一目で確認でき、チームでの共同作業にも適している。
GitHubやGitLab、NotionといったプラットフォームはMermaidに標準対応しており、コードブロック内に記述するだけで図が自動的に描画される。Markdownとの親和性が高く、技術文書やReadmeファイルへの図の埋め込みに広く活用されている。図のテーマ変更やノードの色付けといった外観のカスタマイズもテキストで指定でき、専門的なデザイン技術がなくても統一感のある図を作成できる。
一方、あくまでも「素早くシンプルな図を文書の中に埋め込む」ことに主眼を置いた記法であり、複雑なレイアウトの細かい調整は苦手である。図形の位置を厳密に制御したい用途には専用の作図ツールの方が適している。また、対応している機能は利用環境によって異なり、一部のサービスでは正しく表示されない場合もある。