Typemark Documentation

ダイアグラム

コードフェンス内のテキストから、フローチャート、シーケンス図、その他のMermaidダイアグラムを描画します。

2026年11月19日更新

コードフェンスに言語 mermaid を指定して Mermaid ダイアグラムを記述すると、公開されたページでダイアグラムが描画されます。ダイアグラムはページ内のテキストとして保存されるため、他のドキュメントと同じように差分確認やレビューができます。

flowchart LR
  A[Write MDX] --> B[Push to GitHub]
  B --> C{Build passes?}
  C -->|Yes| D[Site is live]
  C -->|No| E[Previous version stays up]
```mermaid
flowchart LR
  A[Write MDX] --> B[Push to GitHub]
  B --> C{Build passes?}
  C -->|Yes| D[Site is live]
  C -->|No| E[Previous version stays up]
```

ダイアグラムは、読者のライトテーマまたはダークテーマに合わせて表示され、テーマが切り替わると再描画されます。

ダイアグラムの種類

Mermaidがサポートするダイアグラムはすべて利用できます。例:

ダイアグラム1行目
フローチャートflowchart LR または graph TD
シーケンス図sequenceDiagram
クラス図classDiagram
状態遷移図stateDiagram-v2
エンティティ関係図erDiagram
ガントチャートgantt
円グラフpie
sequenceDiagram
  participant App
  participant API
  App->>API: POST /tokens
  API-->>App: 201 Created
```mermaid
sequenceDiagram
  participant App
  participant API
  App->>API: POST /tokens
  API-->>App: 201 Created
```

タブとコードグループ内

ダイアグラムは、コードブロックを置ける場所ならどこでも使えます。Tabs や Code groups の中も含みます。コードグループでは、mermaid の後ろのラベルがタブ名になります。

<CodeGroup>
```mermaid Flow
flowchart LR
  Request --> Response
```

```bash curl
curl https://api.acme.com/health
```
</CodeGroup>

ダイアグラムにエラーがある場合

Mermaidがダイアグラムを読み取れない場合、ページにはそのソースがコードブロックとして表示され、「Parse error on line 2」などエラー内容を示す短い注記が付きます。ページの他の部分には影響しません。ダイアグラムを修正して、再度公開してください。

JavaScriptを無効にしている読者や、ページをMarkdownとして、または llms.txt を通じて読み取るAIツールには、ダイアグラムのソースが提供されます。

セキュリティ

ダイアグラムは、Mermaidの strict セキュリティレベルを使用して読者のブラウザ内で描画されます。ラベルにスクリプトを含めることはできず、ダイアグラム内のクリック操作は無効になっています。

ビジュアルエディタでの操作

Mermaidブロックは、入力するコードブロックのままで、その下にダイアグラムが描画されます。入力を止めてしばらくすると描画が更新され、ダイアグラムにエラーがある場合はそのエラーが表示されます。作成するには、Code block を挿入し、言語選択から Mermaid を選んでください。