MDI 2.1 の編集コメント

MDI 2.1 は、宣言済みの 2.0 とバージョン未宣言の原稿を含むすべての文書で <!-- note --> をコメントとして認識する。コメントは空でも、複数行でも、Unicode でもよい。最も近い --> で閉じ、中身は解釈されない。コード、front matter、リンク先、プレーンテキストの MDI パラメータはリテラルのまま残る。開始記号は \<!-- でエスケープする。

ソースの保存ではコメントを残す。既定の parse / prepare / mdast API は IR 1.0 としてコメントを省く。{ includeComments: true } は位置つきの comment ノードと IR 1.1 を返す。どちらも syntax 2.1 と報告する。既存の front matter 宣言は維持される。公開される本文の projection と layout は、コメントを含む木でもコメントを除く。source map の run はその隙間を保つ。

すべての出版形式は、有効なコメントを常に出力しない。これは、コメントを HTML のテキストとして出していた古い 2.0 の出力を意図的に変える。閉じていないコメントはリテラルのまま残り、mdi.comment.unterminated を返す。書き出しは許可されるので、隠したつもりの文章が見えることがある。

コメントを失わずに残すには、source serialization か、コメントを含む IR を使う。フィルタ済みの外部 IR からは、省かれたコメントを復元できない。

Before<!-- editorial note -->after