GitHub、Markdown構文でフローチャートやクラス図、ガントチャートなどのダイアグラムを表示できる「Mermaid」をサポート開始

今回は「GitHub、Markdown構文でフローチャートやクラス図、ガントチャートなどのダイアグラムを表示できる「Mermaid」をサポート開始」についてご紹介します。

関連ワード (変換、期待、表示等) についても参考にしながら、ぜひ本記事について議論していってくださいね。

本記事は、Publickey様で掲載されている内容を参考にしておりますので、より詳しく内容を知りたい方は、ページ下の元記事リンクより参照ください。


GitHubは、Markdown構文で記述するとダイアグラムを表示できる「mermaid」のサポートを発表しました。

You can now embed diagrams directly into your Markdown files, Issues and PR comments using Mermaid. Learn more – https://t.co/gfmNOp3HeJ

— GitHub (@github) February 14, 2022

Markdown構文とは、テキストを簡単な記号で修飾することにより、HTMLを記述するよりも手軽にハイパーリンクや見出しなどを記述できる記法です(このPubickeyの本文も、ふだんはMarkdown構文で書いています)。

GitHubではIssueやプルリクエストのコメントなどさまざまな場所でマークダウン構文が使えるため、外部ドキュメントへのリンクなどを気軽に入力し、見やすく表示できます。

今回、このMarkdown構文を用いて図が記述できる「Mermaid」と呼ばれる記法が追加されました。

Mermaid記法を用いるとテキストを基に、フローチャート、シーケンス図、クラス図、ステート図、ER図、ガントチャート、パイチャート、ユーザージャーニーなどの図が自動的に生成され表示されます。

例えば、次のように記述すると、自動的に下記の図に変換して表示してくれます。

fig

これによりテキストの入力だけでビジュアルな表現を埋め込めるようになるため、より分かりやすいコメントやドキュメントを手軽に作れるようになることが期待されます。

COMMENTS


Recommended

TITLE
CATEGORY
DATE
安全なデジタル社会の構築に貢献–カスペルスキー・小林社長
IT関連
2023-01-13 02:49
「新型コロナに有効」うたいマイナスイオン発生器販売 消費者庁が措置命令 業者は反発
くらテク
2021-04-02 17:45
映画「スラムダンク」予告動画、計530万回再生 発表から2日で 「幅広い年代から支持」と東映
くらテク
2021-08-17 08:02
ビル・ゲイツ氏、バイデン大統領との協力に意欲–コロナや気候変動などで
IT関連
2021-01-22 20:10
[速報]「Docker Desktop for Linux」が登場、WindowsやMac版と同じ機能や操作を提供、Raspberry Pi OSにも対応
Docker
2022-05-11 20:11
半導体ウェハメーカーのSK SiltronがEVサプライチェーン強化へ米国で330億円投資
モビリティ
2021-07-16 21:10
センサーの追加なしでフィットネスバイクのケイデンスを測定するシステムのMotosumoが6.5億円を調達しPelotonに戦いを挑む
ソフトウェア
2021-03-26 09:09
データ侵害のコストが過去最高を更新、医療業界の被害がより高額に–IBMレポート
IT関連
2022-07-29 05:12
岐阜県内18自治体、電子契約「クラウドサイン」の実証実験
IT関連
2022-07-12 17:16
三井倉庫SCS、「事故管理・ヒヤリハット管理」システムを開発
IT関連
2022-09-29 22:22
中小企業のマーケティングとセールスを自動化するActiveCampaignは評価額3200億円で260億円調達
ネットサービス
2021-04-23 00:09
Cohesity、ランサムウェア対策を機能強化–最新版「Pegasus 6.8」のIPR版をリリース
IT関連
2022-06-25 08:59
パキスタンが一時的にソーシャルメディアをブロック中
ネットサービス
2021-04-17 04:33
レノボがテック大手のCEOらと披露した全方位のハイブリッドAI戦略
IT関連
2024-10-23 02:59