Markdown共有ガイド / Mermaidと数式を共有

Mermaidと数式をMarkdownで共有する方法

markdown共有ツールは、Mermaidコードブロックを図として、$...$と$$...$$をKaTeX数式として表示します。専用エディタを持たない相手にも、図と数式を含む設計書をブラウザで共有できます。

1. Mermaidをコードフェンスで囲む

```mermaid
flowchart LR
  A[Markdownを追加] --> B[プレビュー]
  B --> C{表示は正しい？}
  C -- はい --> D[共有URLを作成]
  C -- いいえ --> A
```

開始行を```mermaidにし、終了行を```にします。通常のコードブロックやmermaid指定のないブロックは図になりません。フローチャート、シーケンス図などは、まず小さい図で構文を確認してから要素を増やします。

2. インライン数式とブロック数式を書く

インライン数式は $E = mc^2$ のように書きます。

ブロック数式:

$$
\frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
$$

文中の短い式は1個の$で囲み、独立した式は前後を2個の$$で囲みます。バックスラッシュを含む式をJSONやプログラム内から送る場合は、その言語側のエスケープも必要です。

3. 公開前にプレビューする

1. アップロード画面へMarkdownを追加します。
2. プレビューへ進み、Mermaidが図に変わっているか確認します。
3. 数式の記号、添字、分数、改行位置を原文と照合します。
4. スマートフォン幅でも横にはみ出しすぎないか確認します。
5. 問題がなければ共有URLを作成します。

実際の表示はMarkdown表示サンプル集で、公開前に確認できます。

4. 表示されない場合の確認点

5. 設計書を共有するときの注意

• 図だけに依存せず、目的や判断理由を本文でも説明する
• 巨大な図は複数の小さい図へ分ける
• 外部向け文書から内部ホスト名、構成情報、秘密情報を除く
• 公開後は編集できないため、修正時は新しい共有URLを作る
• 長期保管する原本はGitなど別の管理先へ残す

Mermaid・数式入りMarkdownを共有する

最終確認日: 2026年8月3日 / 確認: markdown共有ツール運営