Markdown変換にrehypeの自作プラグインを挟む【アフィリエイトのrel自動付与とh1のh2降格】
- この記事で分かること
- アフィリエイトリンクにrel="sponsored nofollow noopener"とtarget="_blank"を強制付与するプラグインと、本文のh1をh2に下げるプラグインを、unifiedの変換パイプラインに差し込む実装
- 実際に使った環境
- Next.js 16.3.1(App Router)/ unified・remark・rehype。src/lib/markdown.tsとして、このブログの記事とカテゴリーページの本文変換に実際に使っている実装です
- 筆者の結論
- 人間が毎回気をつける運用は、いつか必ず漏れる。漏れて困ることは、書き手の注意ではなく変換処理で防ぐ方が確実。ただしプラグインの並び順を間違えると、何も起きずに素通りする
このブログの記事は、Markdownで書いています。ただし、おすすめ枠や吹き出し風のコメントボックスなどは、Markdownの中にHTMLを直接書く運用です。便利な反面、HTMLを手で書くので、書き手の付け忘れが起こりえます。
この記事では、そうした付け忘れを、記事を書く人の注意力ではなく、Markdownからの変換処理で防ぐために作った、rehypeの自作プラグイン2つを紹介します。
🛠 実装してみて分かったこと
プラグイン本体は、どちらも十数行です。難しいのは書くことよりも、変換パイプラインのどこに挟むかでした。直書きしたHTMLの中のリンクを書き換えるプラグインは、rehype-rawという別のプラグインを前段に置かないと、エラーも出さずに何も書き換えないまま素通りします。動いているように見えて、実際には何もしていない、という状態が一番怖いと感じました。
変換パイプラインの全体像
このブログの本文変換は、unifiedというライブラリのパイプラインでできています。Markdownを読み込み、HTMLの構造(AST)に直し、プラグインを順に通して、最後にHTML文字列にします。
const processed = await unified()
.use(remarkParse)
.use(remarkGfm)
.use(remarkRehype, { allowDangerousHtml: true })
.use(rehypeRaw)
.use(demoteH1)
.use(rehypeSlug)
.use(collectHeadings(headings))
.use(enforceAffiliateLinkAttrs)
.use(wrapContentImages(sourceLabel))
.use(rehypePrettyCode, { theme: "one-dark-pro", keepBackground: true })
.use(rehypeStringify, { allowDangerousHtml: true })
.process(content);.use()を並べた順に、上から下へ処理されます。この記事で扱うのは、demoteH1とenforceAffiliateLinkAttrsの2つです。
前提: rehype-rawがないと、直書きHTMLは「ただの文字」のまま
まず、rehypeRawが必要な理由です。
remarkRehypeにallowDangerousHtml: trueを渡すと、Markdown中に直書きしたHTMLは捨てられずに残ります。ただし、このときのHTMLは、aタグやdivタグといった要素ではなく、**中身を解釈していない文字列のかたまり(rawノード)**として保持されます。
そのため、後段のプラグインが「a要素を探して書き換える」と書いても、直書きHTMLの中のaは要素として存在しないので、見つけられません。rehypeRawを通すと、その文字列がきちんと解釈され、普通の要素に展開されます。これで初めて、後段のプラグインが直書きHTMLの中身をたどれるようになります。
// remark-rehypeのallowDangerousHtmlは、本文中に直書きした生HTML(アフィリエイトCTA等)を
// 未解析の"raw"ノードとしてしか保持しないため、rehype-slugや自作プラグイン(見出し収集・
// rel自動付与)がそれらをたどれない。rehype-rawで実際のHAST要素に展開してから後段に渡す。
.use(rehypeRaw)プラグイン1: アフィリエイトリンクにrelを強制付与する
アフィリエイトリンクには、広告であることを検索エンジンに伝えるrel="sponsored"などを付ける必要があります。このブログでは、記事を書くときにも手で付けるようにしていますが、付け忘れても変換時に補完されるようにしています。
// アフィリエイトプログラムのリンク先ドメイン。
const AFFILIATE_HOSTS = [/(^|\.)a8\.net$/i];
function isAffiliateHref(href: string): boolean {
try {
// 相対パス(サイト内リンク)はここで例外になりfalseを返す。
const { hostname } = new URL(href);
return AFFILIATE_HOSTS.some((pattern) => pattern.test(hostname));
} catch {
return false;
}
}
function enforceAffiliateLinkAttrs() {
return (tree: Root) => {
visit(tree, "element", (node: Element) => {
if (node.tagName !== "a") return;
const href = node.properties?.href;
if (typeof href !== "string" || !isAffiliateHref(href)) return;
node.properties.target = "_blank";
const existingRel = Array.isArray(node.properties.rel)
? node.properties.rel.map(String)
: [];
const requiredRel = ["sponsored", "nofollow", "noopener"];
node.properties.rel = Array.from(new Set([...existingRel, ...requiredRel]));
});
};
}どのリンクを対象にするか
判定は、リンク先のドメイン(ホスト名)で行っています。/(^|\.)a8\.net$/iという正規表現は、a8.netそのもの、またはxxx.a8.netのようにそれで終わるホスト名だけに一致します。not-a8.netのような、末尾が似ているだけの別ドメインには一致しません。
new URL(href)は、/blog/xxxのような相対パス(サイト内リンク)を渡すと例外を投げます。それをcatchで受けてfalseを返すことで、内部リンクが自動的に対象外になります。
手で書いたrelは消さない
existingRelに、すでに書かれているrelの値を取り出し、必要な3つ(sponsored・nofollow・noopener)を足して、Setで重複を除いています。手でrel="sponsored"だけ書いてあった場合でも、残りの2つが補われ、sponsoredが二重になることもありません。target="_blank"も、新しいタブで開くようにあわせて付与します。
対象になるアフィリエイト事業者を増やすときは、AFFILIATE_HOSTSの配列に正規表現を足すだけです。
プラグイン2: 本文のh1をh2に下げる
もう一つは、本文中のh1をh2に下げるプラグインです。
function demoteH1() {
return (tree: Root) => {
visit(tree, "element", (node: Element) => {
if (node.tagName === "h1") node.tagName = "h2";
});
};
}記事ページやカテゴリーページは、テンプレート側で記事のタイトルをh1として出力しています。Markdown本文に# 見出しと書かれていると、1ページにh1が2つになってしまいます。h1は「そのページの主題」を表すものなので、1ページに1つにしておくのが望ましいとされています。
きっかけは、このブログに実際に起きた不具合です。AIトレードやX運用の自動生成記事(日誌・週次ログ)が、本文の先頭に# 見出しを出力していて、h1が重複していました。生成側のプログラムも修正しましたが、今後の書き忘れに備えて、変換側でも機械的に防ぐようにしました。
プラグインの並び順が意味を持つ
このパイプラインでは、順序に意味があります。
| 順序 | プラグイン | 順序の理由 |
|---|---|---|
| 1 | rehypeRaw | 直書きHTMLを要素として展開する。以降のすべてが、これに依存する |
| 2 | demoteH1 | rehypeSlugより前に置く |
| 3 | rehypeSlug | 見出しにidを付ける |
| 4 | collectHeadings | id付きのh2から目次データを集める |
| 5 | enforceAffiliateLinkAttrs | rehypeRawの後なら、どこでもよい |
demoteH1をrehypeSlugと目次の収集より前に置いているのは、下げた後のh2にもidを付け、目次にも載せたいからです。順序が逆だと、h1のままの状態でidが付けられ、目次の収集時にはh1が対象外となって、目次から漏れてしまいます。
目次の仕組みは、追従目次の記事で詳しく解説しています。
よくある質問
Q. なぜrel属性を、記事を書くときに手で付けるだけにしないのですか?
A. アフィリエイトリンクにはrel="sponsored"を付けることが求められますが、記事は生HTMLで直書きしているため、書き手が付け忘れると、そのまま公開されてしまいます。変換時に機械的に補完しておけば、付け忘れても出力側で必ず付きます。手で書いた属性が既にある場合は、それを残したまま不足分だけを足します。
Q. rehype-rawは何のために入れているのですか?
A. remark-rehypeのallowDangerousHtmlは、Markdown中に直書きしたHTMLを未解析のrawノードとして保持するだけで、実際の要素としては扱いません。rehype-rawを通して初めて、後段のプラグインがその中のaタグや見出しをたどれるようになります。これが無いと、直書きHTMLの中のアフィリエイトリンクには、今回のプラグインが効きません。
Q. h1をh2に下げると、目次はどうなりますか?
A. プラグインの順序を、h1の降格→見出しidの付与→目次データの収集としているので、下げたh2も通常のh2と同じようにidが付き、目次に載ります。
まとめ
アフィリエイトリンクのrelとh1の重複は、どちらも「書き手が気をつければ防げるが、いつか漏れる」種類の問題です。そういう問題は、運用ルールを増やすより、変換処理に任せてしまう方が確実でした。
プラグイン自体は短く書けますが、並べる順序には理由があります。特に、直書きHTMLの中身を扱うプラグインはrehype-rawの後に置かないと、エラーも出さずに何もしません。「ちゃんと動いているか」は、出力されたHTMLを実際に見て確かめるのが確実です。