Skip to main content

no-html-links

Docusaurusの<Link>コンポーネントを、<a> タグの代わりに使用するようにしてください。

<Link> コンポーネントには、プリフェッチやプリロードの機能が組み込まれています。 また、ビルド時にリンク切れを検出し、Docusaurusがサイトの構造をより正確に把握できるよう支援します。

ルールの詳細

このルールに対する不適切なコード例:

<a href="/page">go to page!</a>

<a href="https://x.com/docusaurus" target="_blank">X</a>

このルールに対する適切なコード例:

import Link from '@docusaurus/Link'

<Link to="/page">go to page!</Link>

<Link to="https://x.com/docusaurus">X</Link>

ルールの設定方法

Accepted fields:

OptionTypeDefault説明
ignoreFullyResolvedbooleanfalseignoreFullyResolved を true に設定すると、プロトコルを含む絶対URLの <a> タグはレポートされなくなります。