nikkie-ftnextの日記

イベントレポートや読書メモを発信

キー入力だけでフローチャートができてすげええええええ! Mermaidを触ってみました

はじめに

なんて素敵なの!1 nikkieです。

描画ツールをいじらずにフローチャートを書いてみたく、Mermaidを試してみました🧜‍♀️

目次

GitHubはMermaidをサポート

2022年2月からサポート。
おぼろげながら話題になっていた覚えがあります。

ダイアグラムの作成 - GitHub Docs

たとえば、Mermaid ではフローチャート、シーケンス図、円グラフなどをレンダリングできます。

Mermaid ダイアグラムを作成するには、mermaid 言語識別子をもつコード ブロック内に Mermaid 構文を追加します。

動作環境

Issueでぱっと試し、この記事を書く際はVS Code拡張を試しました。

GitHub blogのフローチャートの例を写経

mermaid 言語識別子をもつコードブロック内の書き方です(コードブロック全体はrawで見てください)。

完全一致で写経したわけではなく、ドキュメントを元に細かいところを変えています。

Mermaidのドキュメントより

Node Eに閉じるところは、テキストを書くのを1回だけにできました。
GitHub blogの例では、テキストを2回繰り返しています。
NodeのIDが同じだからうまくいくんじゃないかと思っていますが、ドキュメント中に記載をまだ見つけられていません。

終わりに

フローチャートは描画ツール不要(キー入力だけ)で作れる! Mermaidならね

これはなかなか好感触です。
過去、Draw.io拡張3を使ってVS Codeで図を作りました4が、全てテキストで完結するのはとてもいいですね!

今回触ったのはフローチャートですが、Mermaidはほかの図も書けるという!
いや〜、これは素晴らしいな〜。引き続き素振りしていこう!