チャートと図の表現力
mybook では Mermaid を使って多彩な図を描画できます。ここではさまざまな種類のダイアグラムを紹介します。
フローチャート(基本)
処理の流れをシンプルに表現します。
Loading diagram...
シーケンス図
コンポーネント間のやり取りを時系列で示します。
Loading diagram...
クラス図
オブジェクト指向の設計を可視化します。
Loading diagram...
状態遷移図
アプリケーションの状態変化を表します。
Loading diagram...
ER図
データベースの構造を表現します。
Loading diagram...
Gitグラフ
ブランチ戦略を可視化します。
Loading diagram...
パイチャート
割合をわかりやすく表示します。
Loading diagram...
Callout コンポーネントの例
Info
Mermaid の図はダークテーマで自動レンダリングされます。画面幅に応じて縮小表示されるため、スマートフォンでも読めます。
Warning
1つの図にノードを詰め込みすぎるとモバイルで見づらくなります。ノードは 7 個以下、ラベルは短くしましょう。
GFM テーブル
Mermaid 以外にも、GFM テーブルで情報を整理できます。
| 図の種類 | 用途 | モバイル表示 |
|---|---|---|
| フローチャート | 処理の流れ | ノード7個以下推奨 |
| シーケンス図 | API通信 | 参加者4人以下 |
| クラス図 | 設計の可視化 | メソッド少なめに |
| 状態遷移図 | 状態管理 | 状態5つ以下 |
| ER図 | DB設計 | テーブル4つ以下 |
| パイチャート | 割合表示 | 項目5つ以下 |
コードブロック(比較用)
通常のコードブロックがMermaidの変換で壊れていないか確認します。
interface Topic {
slug: string;
title: string;
description?: string;
order: number;
}
function getTopicUrl(topic: Topic): string {
return `/${topic.slug}`;
}{
"title": "チャートと図の表現力",
"description": "Mermaid サンプル集",
"order": 3
}