Mermaid(マーメイド)記法とは?
Mermaid(マーメイド)記法を調査しているときの覚書。 Gemini 3 Flash Previewと対話。 1. Mermaid記法の概要 Mermaidは、テキストベースで図を描画するためのJavaScriptライブラリおよびその記法。 Diagrams as Code (DaC) 「図をコードとして扱う」という思想に基づいている。 専用の描画ソフトを使わず、使い慣れたエディタでテキストを書くだけで、フローチャート、シーケンス図、ER図、クラス図などを生成できる。 エンジニアへのメリット Git管理: テキストデータであるため図の変更履歴をGitで管理し、プルリクエストで差分(diff)を確認できる。 自動レイアウト: 線の接続や配置はMermaidが自動で行うため、ユーザーは「構造」の記述に集中できる。 高いポータビリティ: 多くのドキュメントツールやIDEで標準サポートされている。 2. 歴史およびMarddown(マークダウン)記法との関わり Mermaidは、Markdownエコシステムの中で「図解を担当する標準パーツ」としての地位を確立してきた。 歴史 2014年にKnut Sveidqvist氏によって公開された。 2019年にJS Open Source Awardsを受賞し、エンジニアの間で「PlantUMLよりも手軽な選択肢」として急速に普及した。 Markdownとの関係 シームレスな統合: Markdownのコードブロック記法( ```mermaid )の中に直接記述できるのが最大の特徴。 プラットフォームの採用: 2022年にGitHubがネイティブサポートを開始したことが決定打となり、GitLab、Notion、Obsidian、Azure DevOpsなど、主要な開発プラットフォームで標準的にレンダリングされるようになった。 Docs as Codeの実現 「文書(Markdown)」と「図(Mermaid)」を同じテキストファイル内で管理できるようになったことで、ドキュメントのメンテナンス性が飛躍的に向上した。 3. 生成AIとの親和性 Mermaidは、現代の生成AI(ChatGPT, Claude, Gemini等)と極めて相性が良い記法。 AIが得意な構造化出力: 生成AIにとって、ピクセル単位の「画...