Mermaid Live — 使い方

Confluence のページに Mermaid を貼り、その場でライブ編集し、図が入ったまま PDF・Word にエクスポートできます。

Mermaid Live がすること

Mermaid Live は Confluence Cloud のページ上で Mermaid の図を描画するアプリです。マクロに Mermaid ソースを入力すると、打ったそばから図になり、ページを PDF・Word にエクスポートすると同じ図が原寸の画像として入ります。

すべて Atlassian の Forge プラットフォーム上で動きます。アカウント登録も外部サービスも無く、Atlassian の外にあるサーバーへは一切通信しません。図のソースと描画画像は、お客様の Confluence ページと Forge のアプリストレージに保存されます。

描画エンジンは Mermaid 11 です。フローチャート、シーケンス図、クラス図、状態遷移図、ER図、ガントチャート、円グラフ、マインドマップ、git グラフ、ジャーニー、タイムライン、4象限チャートに対応しています。

ページを編集して「/mermaid」と入力し、Mermaid Live を選びます。マクロを挿入するとそのままエディタが開きます。テンプレートを選ぶ必要も、別のアプリを開く必要もありません。

Mermaid ソースを入力または貼り付けて保存すると、ページに図が表示されます。同時に描画結果が保存され、後のエクスポートで図の埋め込みに使われます。

エディタは2ペイン構成です。左にシンタックスハイライトと行番号つきの Mermaid ソース、右に入力へ即座に追従するライブプレビュー。中央の仕切りをドラッグして幅を調整できます。

ソースに文法エラーがあるときは、パーサのエラーメッセージを表示しつつ、最後に成功したプレビューを薄く残します。編集の途中で図が消えてちらつくことはありません。

図種だけで中身がまだ無いソース（例:「graph TD」の1行だけ）を保存すると、ページには空白の箱ではなく「まだ要素がない」旨の短い表示が出ます。

図・ソース・その両方のどれを見せるかは図ごとに選べ、選択はマクロと一緒に保存されます。

図ごとにテーマ（Light / Dark）も選べ、マクロと一緒に保存されます。ダークテーマの Confluence でも図を見やすくできます。

図をクリックすると全画面で開きます。開いた瞬間はウィンドウにフィットし、そこからホイールでカーソル位置を中心に拡大縮小、ドラッグで移動できます。ツールバーには Fit・＋・− のボタンがあります。200ノードのフローチャートも、サムネイルではなく読める図になります。

Confluence 標準のエクスポート（エクスポート → PDF / Word）をそのまま使います。Pro プランでは、図はコードブロックでも空白でもなく、原寸の画像として出力されます。

黙って消えたり、古い図が紛れ込んだりはしません。一度も描画に成功していない図や、最後の描画成功のあとにソースが変わった図は、誤った画像や空白の代わりに Mermaid ソースのコードブロックとして出力されます。Free プランでは、すべての図がソースのコードブロックとして出力されます。

エディタ・ライブプレビュー・描画・ズーム・全画面は無料です。図を埋め込んだ PDF・Word エクスポートは Pro プランの機能です。10ユーザー以下のサイトは Pro を無料で使え、30日間の無料トライアルもあります。

ページを含める（Include Page）では図が出ない: Confluence は「ページを含める」マクロで取り込んだコンテンツの中で Forge アプリを実行しないため、取り込み先では図が表示されません（どのアプリにも直せない制限です）。代わりに、取り込み元のページで図を「抜粋（Excerpt）」で囲み、「抜粋を挿入（Insert Excerpt）」で取り込んでください。この方法なら表示もエクスポートも正常です。
スクリプトや REST API で作ったページ: スクリプトや REST API で作成して一度も Confluence のエディタで開いていないページは、エクスポートが不完全になることがあります（PDF が進まない、本文が入らない等）。そのページを一度エディタで開いて「更新」を押せば、それ以降のエクスポートは正常です。エディタで書いたページでは起きません。
版の表示・版の比較: ページの版の表示や2つの版の比較では、Confluence がアプリに必要な情報を渡さないため、図が Mermaid ソースまたは空白で表示されることがあります。現在のページの表示と PDF・Word エクスポートには影響しません。

メールをいただければ2営業日以内に返信します。起きたページ、入力した内容、そして期待した結果を書き添えてください。