マークダウンのHTMLコメントを正規表現で一括削除する方法

GitHubのオープンソースのREADME.mdを整えたり、技術文書の翻訳を共同作業したりしていると、外部に見せたくない内部メモや翻訳の参考用の文章をMarkdownのコメントとして隠して書き残しておくことがよくあります。
しかし、最終的な配布物(Static Build)を作って公開したり、一般の読者にMarkdown文書を公開したりする段階になると、こうした内部向けのHTMLコメントがテキストソースにそのまま残って見えてしまうことがあります。この記事では、Markdown文書の中のHTMLコメントだけを選んで削除する正規表現の仕組みと、見落としがちな例外を整理します。
1. MarkdownのHTMLコメントを消す正規表現の仕組み
Markdownの仕様で使われるコメントの形式は、HTMLと同じ<!-- コメント内容 -->という構造です。この構造だけを選んで文書全体から削除する正規表現は次のとおりです。
/<!--[\s\S]*?-->/g
正規表現がやっていること
<!--,-->: コメントの開始と終了の境界です。[\s\S]*?: 改行文字(\s)と非改行文字(\S)の両方を含めることで、改行が入った複数行のコメントまで捉えます。- 疑問符(
?)は非貪欲(non-greedy)マッチングです。これが抜けると、文書にコメントが複数あるときに最初のコメントの開始から最後のコメントの終わりまでを丸ごと消してしまう誤動作が起きます。
この正規表現を文字列置換関数に渡せば、コメントだけが除かれた結果を得られます。
cleanedText = originalText.replace(/<!--[\s\S]*?-->/g, "")
2. ビルド処理にコメント削除を組み込む方法
実務では、MarkdownをHTMLに変換するビルド段階にこの置換を入れて自動化します。
// Next.js などの静的サイトにおける Markdown パイプラインの例
function markdownLoader(content) {
// コンパイル直前に HTML コメントを削除して
// 内部向けの文言が配布物に残らないようにします。
const cleanContent = content.replace(/<!--[\s\S]*?-->/g, "");
return marked.parse(cleanContent);
}
毎回エディタで検索(Ctrl+F)してコメントを目で確認しながら消したり、Gitに上げる前に手作業でチェックしたりする必要はありません。 下のMarkdownコメント削除器に原文を貼り付ければ、同じ正規表現でコメントだけを選んで削除した結果をそのままコピーできます。削除した箇所に空行が残るのが嫌な場合は「空行を整理」オプションを一緒にオンにすればよく、いくつのコメントが削除されたかも画面に表示されます。
コメントの整理が必要なマークダウンの文をコピーして貼り付け、「コメントを一括削除」ボタンを押すだけで、外部に安全に共有できるきれいな配布用の文面を用意できます。

3. コメントを消すときによく見落とす例外
| 状況 | 注意すべき点 |
|---|---|
サンプルコードの中に<!--という文字列がそのまま入っている場合 | コード例として見せるために書いておいた<!--という文字列まで一緒に消えてしまいます。コードブロックの領域を先に切り離しておき、コメント削除後に戻す必要があります。 |
Jekyll・Astroなどのフロントマター(文書冒頭の---区間) | 文書の最上部にあるYAMLメタデータもコメント用の正規表現の範囲に入ることがあるため、行単位でフロントマターの領域を区別して除外する必要があります。 |
| 複数のコメントが離れて存在する文書 | 非貪欲(?)マッチングが抜けると、前述のとおり最初のコメントから最後のコメントまで丸ごと削除されます。 |
まとめ
MarkdownのHTMLコメントは/<!--[\s\S]*?-->/gという正規表現で削除できます。非貪欲マッチングを忘れなければ、複数のコメントがある文書で途中の本文まで消えてしまう事故を防げます。また、コード例の中の<!--という文字列とフロントマターの領域は別途処理すると安全です。自分で正規表現を実行するのが面倒な場合は、ツールに原文を貼り付ければすぐに結果を確認できます。
コメントの整理が必要なマークダウンの文をコピーして貼り付け、「コメントを一括削除」ボタンを押すだけで、外部に安全に共有できるきれいな配布用の文面を用意できます。
よくある質問
コメントの中にMarkdownの記法が入っていても削除されますか?
はい。<!-- -->の間にある内容は、形式に関係なく丸ごと削除の対象です。中にMarkdownの記法や通常のテキストが混ざっていても、コメントの境界(<!--、-->)を基準に削除されます。
HTMLファイルにも同じ正規表現を使えますか?
はい、HTMLのコメント表記は同じなので、同じパターンがそのまま動作します。ただしHTMLでは<script>・<style>タグの中に似た文字列が入ることがあるため、Markdownより一段と例外を確認したほうが安全です。
この記事は韓国語の原文をもとに作成しています。 韓国語の原文を読む