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
ヤマト運輸のデータドリブン経営を支える4階層の組織(前編)
IT関連
2023-03-01 21:07
4月は日銀のETF買いなし–上がるも下がるも外国人次第の日本株に逆戻り
IT関連
2021-04-14 09:57
SCSK、AWSと戦略的協業–3つの重点施策で提供体制を強化
IT関連
2023-10-26 04:28
シンガポール拠点のライドシェアSWAT Mobilityが資金調達、日本におけるサービス開発に投資
シェアリングエコノミー
2021-02-09 19:21
LINE PayでVisaタッチ決済可能に、「Google Pay」対応でLINEアプリの起動不要
フィンテック
2021-02-05 10:45
LinkedInがヘイトスピーチの削除に関するEUの行動規範に正式署名
ネットサービス
2021-06-28 02:03
【3月23日】掲載記事アクセスランキング・トップ5―1位はテスラ事業計画、2位は欧米の制裁でロシアから逃げ出すテック人材
IT関連
2022-03-24 23:14
脅威と実態不明なデータで増大するリスク–データ保護とセキュリティ対策を統合すべき理由
IT関連
2022-04-15 19:20
Cloudflare WorkersがPythonをサポート、WebAssembly版Pythonランタイムの「Pyodide」を採用で
Cloudflare
2024-04-03 04:22
Plumeがブロードバンドプロバイダー向けにスマートホーム用Wi-Fiを強化、評価額1420億円で285億円調達
ソフトウェア
2021-02-25 04:01
取引先ITベンダーのリスク、事業継続などの対策進まず–ガートナー調査
IT関連
2022-08-23 19:17
米政府機関、産業用システムに対する攻撃の典型的手口や対策を公開
IT関連
2022-09-29 01:42
EUの主管プライバシー規制当局が行動監視に基づくターゲティング広告の禁止を求める
IT関連
2021-02-27 08:52
Sansan、インボイス管理サービス「Bill One」で「発注データ照合オプション」提供
IT関連
2023-07-25 17:02