Markdown

Markdown で SVG や HTML をそのまま出す書き方に、標準がない理由

Markdown には、SVG の図や HTML を「そのまま出す」ための標準の囲みがありません(ツールごとの書き方は前の記事にまとめました)。よく使われそうなのに、なぜ標準にならなかったのか。理由は、Markdown の生まれをたどるとわかります。

足りないところは HTML で書く、が最初の決まり

Markdown は 2004 年に John Gruber が作りました。目的は「読みやすい文字のまま書けて、HTML に変換できる」ことで、文法はわざと小さくしてあります。足りないところは、HTML をそのまま書けばよい、という決まりです。

For any markup that is not covered by Markdown’s syntax, you simply use HTML itself.(John Gruber「Markdown: Syntax」)

今の HTML(HTML5)では <svg> も HTML の一部です。なので、仕様の上では SVG は最初から書ける ことになります。VS Code のプレビューで、本文に直接書いた SVG が描かれるのはこのためです。画像の形式も Markdown は気にしません。![図](figure.svg) は <img src="figure.svg"> に変わるだけで、PNG か SVG かはブラウザが判断します。

出ないのは、表示するサイトの安全の判断

それでも GitHub や Redmine で SVG が出ないのは、Markdown の仕様ではなく、サイトの判断です。

立場本文の HTML(SVG も含む)
Markdown の仕様(CommonMark)そのまま通す
人に見せるサイト(GitHub・Redmine など)安全なタグだけ通す。SVG は落とす

GitHub や Redmine は、他人が書いた文章をほかの人に見せるサイトです。SVG の中にはスクリプトやリンクを入れられるので、そのまま通すと XSS(見た人のブラウザで悪いスクリプトを動かす攻撃)の入口になります。「仕様では書けるのに、サイトでは出ない」のは、この 2 つがずれているからです。

フェンスは「解釈しない」ための、あとから来た書き方

「HTML をそのまま出す」のに ``` の囲み(フェンス付きコードブロック)が使われなかったのには、2 つの理由があります。

年できごと
2004 年Markdown が生まれる。コードは行の先頭に空白 4 つ。HTML は囲まずにそのまま書く
2008 年ごろPHP Markdown Extra が ~~~ で囲む書き方を足す。その後 GitHub が ``` を広める
2014 年CommonMark が、フェンスを正式な仕様に入れる
  • HTML をそのまま書く決まりのほうが、ずっと先にあった。 フェンスが生まれたときには、すでに「囲まずに書く」で決まっていました。
  • フェンスの意味は「中身を解釈しないで、文字のまま見せる」。 中の < や * を HTML や Markdown として扱わない、という合図です。同じ囲みに「HTML として解釈して出す」という逆の意味は持たせにくく、CommonMark も info string(``` の後ろの言葉)の使い方を決めずに、各ツールに任せました。

行き先が HTML だけではなくなった

もう 1 つの流れが、Pandoc のような変換ツールです。Markdown を PDF(LaTeX)や Word にも変換するようになると、「この部分は HTML のときだけそのまま出す」「この部分は LaTeX のときだけ出す」と、行き先を指定する必要が出てきます。Pandoc の ```{=html} や ```{=latex} は、そのための書き方です。HTML しか考えていなかった最初の Markdown には、この発想がありませんでした。

まとめ

  • Markdown は「足りないところは HTML で書く」作りなので、SVG は仕様上、最初から書ける。出ないのは、表示するサイトが安全のために絞っているから。
  • フェンスは「解釈しないで見せる」ための、あとから来た書き方。「HTML として出す囲み」は標準に入らず、各ツールが独自に作った。
  • このブログの下書きで使っている ```html-raw(記事にするとき WordPress の「カスタム HTML」にする)も、Pandoc と同じ発想の独自の決まりです。空行で HTML が切れる弱点を避けつつ、行き先に合わせて扱いを決めています。
スポンサーリンク
タイトルとURLをコピーしました