1. ホーム
  2. syntax

[解決済み] Markdownのコメント

2022-03-14 09:14:32

質問

Markdownでコメントを書く、つまりHTML出力でレンダリングされないテキストを書くにはどうしたらよいでしょうか? には何も見つかりませんでした。 マークダウンプロジェクト .

解決方法は?

これまでに提案されたすべての解決策(特定の実装を必要とするものを除く)は、たとえ表示されない場合でも、出力されるHTMLにコメントが含まれる結果になると思います。

もしあなたが自分自身のためだけのコメントが欲しいなら(変換されたドキュメントの読者はたとえ"view source"でもそれを見ることができないはずです)、コアMarkdown仕様で利用できるリンクラベル(参照スタイルのリンクで使用するため)を(略)使用することができます。

http://daringfireball.net/projects/markdown/syntax#link

ということです。

[comment]: <> (This is a comment, it will not be included)
[comment]: <> (in  the output file unless you use it in)
[comment]: <> (a reference style link.)

あるいは、もっと踏み込むこともできます。

[//]: <> (This is also a comment.)

プラットフォームの互換性を高めるため(そしてキーストロークを1つ節約するため)には、以下のようにすることも可能です。 # (の代わりに(これは正当なハイパーリンクのターゲットです)。 <> :

[//]: # (This may be the most platform independent comment)

最大限の移植性を得るためには、このタイプのコメントの前後に空白行を挿入することが重要です。なぜなら、いくつかのMarkdownパーサーは定義が通常のテキストと衝突すると正しく動作しないからです。Babelmarkの最新の研究では、前後の空白行は両方とも重要であることが示されています。あるパーサーは前に空白行がない場合、コメントを出力し、あるパーサーは後に空白行がない場合、次の行を除外します。

一般的に、この方法はコア仕様の一部であるため、ほとんどのMarkdownパーサーで動作するはずです。(複数のリンクが定義されている場合、またはリンクが定義されているが使用されていない場合の動作は厳密に指定されていないとしても)。