Markdown 記法の対応表 — GitHub / Zenn / Qiita / KakiDoc

同じ Markdown でも、どこに貼るかで結果が変わります。Markdown の標準仕様が決めているのは見出し・箇条書き・強調くらいまでで、表や図、注意書きはサービスごとの拡張だからです。

このページの対応表は、各サービスの公開レンダラに実際に同じ Markdown を通した結果です。手で書いた表ではないので、思い込みは入っていません。

GitHub: Markdown API（mode: gfm）

KakiDoc: このサイトを描画しているレンダラそのもの

一覧

記法	KakiDoc	GitHub	Zenn	Qiita
表	✅	✅	✅	✅
タスクリスト	✅	✅	✅	✅
打ち消し線	✅	✅	✅	✅
脚注	✅	✅	✅	✅
callout（注意書き）	✅	△ 記法が違う	△ 記法が違う	△ 記法が違う
Mermaid 図	✅	△ ブラウザで描画	△ ブラウザで描画	△ ブラウザで描画
数式（ブロック $$）	✅	✅	✅	❌
数式（インライン $x$）	❌	✅	✅	❌
wikilink [[…]]	✅	❌	❌	❌

❌ は「エラーになる」ではありません。記法として解釈されず、記号が見えたまま表示されるという意味です。情報は消えませんが、見た目は崩れます。

どこで差が出るか

上 4 つは、どこでも通じます

表・タスクリスト・打ち消し線・脚注は 4 サービスすべてで同じように表示されます。貼り替えを前提に書くなら、この範囲に収めるのがいちばん安全です。

callout は、4 つとも書き方が違います

一番よく崩れるのがここです。同じ「注意書き」なのに記法が共通していません。

互いに素通しになるので、Qiita で書いた注意書きを Zenn に貼ると崩れます。GitHub では見出しを自分で書くと壊れる、といった細かい罠もあります。

数式は Qiita だけ通りません

$$ … $$ のブロック数式は GitHub・Zenn・KakiDoc で表示されますが、Qiita では記号がそのまま出ます。

逆にインラインの $x$ は KakiDoc が対応していません。KakiDoc で数式を書くときは、段落全体を $$ で囲むブロック形式にしてください。

wikilink は KakiDoc（と Obsidian）だけです

[[ドキュメント名]] でドキュメント同士をつなぐ書き方は、GitHub・Zenn・Qiita のどれでも解釈されず、[[ と ]] がそのまま出ます。

外に出す文章では使わないか、書き出し時に外れることを前提にしてください。KakiDoc は Markdown / HTML への書き出し時に [[…]] を平文に変換します。

Mermaid は「いつ図になるか」が違います

GitHub・Zenn・Qiita はいずれも、サーバーが返すのはコードブロックまでです。図にするのはブラウザ側で、Zenn は埋め込みサーバーを使うなど条件も異なります。つまり「まずコードとして出て、あとから図に変わる」動きになります。

KakiDoc は端末内で描画するので、この待ちがありません。

KakiDoc で書くと

KakiDoc は借り物の記法しか使っていません。callout は GitHub / Obsidian、脚注はGFM / Pandoc、数式は Pandoc / GitHub、[[…]] は Obsidian のものです。独自に発明した記法はありません。

他所へ貼ったときに崩れにくいことを優先して選んでいるので、書いたものはただの Markdown のまま持ち出せます。