no-html-links

Ensure that the Docusaurus <Link> component is used instead of <a> tags.

The <Link> component has prefetching and preloading built-in. It also does build-time broken link detection, and helps Docusaurus understand your site's structure better.

Rule Details

Examples of incorrect code for this rule:

HTML

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

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

Examples of correct code for this rule:

JavaScript

import Link from '@docusaurus/Link'

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

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

Rule Configuration

Accepted fields:

mdx-code-block

<APITable>

Option	Type	Default	Description
`ignoreFullyResolved`	`boolean`	`false`	Set to true will not report any `<a>` tags with absolute URLs including a protocol.

mdx-code-block

</APITable>