いなた屋.Log - Markdown で HTML のコメントを書く

Markdown で HTML のコメントを書く

Created at 2013-02-02 Sat 11:20:04

Markdown に HTML のコメントを埋め込みたくてちょっと調べた。Haml みたいに簡単に書ける？

まずは Haml の例。行頭を “/” から始めるだけ。

~$ cat <<EOS | haml
> /これは HTML のコメントです
> EOS
<!-- これは HTML のコメントです -->

Markdown はどうか。標準記法では無理だけど、kramdown だと次のように書ける。

~$ cat <<EOS | kramdown
> {::comment}これは HTML のコメントです{:/}
> EOS
<p><!-- これは HTML のコメントです --></p>

コメントが <p>…</p> で囲まれるので、これが嫌なら次のように書く。

~$ cat <<EOS | kramdown
> {::comment}
> これは HTML のコメントです
> {:/}
> EOS
<!-- これは HTML のコメントです -->

とりあえず、これで書けるよってのはわかった。でもさぁ～、記述量を減らせるから Markdown を使ってるんで、これだと逆に増えてるじゃん。独自拡張だからどこでも使うわけにいかんし…。

幸い、Markdown では HTML のタグも書くことができる。というか、そっちが正当な考え方だよね。

Markdownのルールでは変換されない部分については素直にHTMLタグを使用してください。

この翻訳は古いドキュメントが元だけど、現在のドキュメントにも同じことが書いてある。

For any markup that is not covered by Markdown’s syntax, you simply use HTML itself.

ということで、Markdown で HTML のコメントを書くなら次が正解。

~$ cat <<EOS | kramdown
> <!-- これは HTML のコメントです -->
> EOS
<!-- これは HTML のコメントです -->

このほうが記述量は少ないし、どのパーサでも使えそうなのでいいな。 (`･ω･´)ｂ OK!!