3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-02 19:57:25 +02:00
Code Issues Projects Releases Packages Wiki Activity
docusaurus/website/docs/api/misc/eslint-plugin/no-html-links.md
Viktor Malmedal 4a448773b6
feat: add eslint plugin no-html-links (#8156) 
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: Viktor Malmedal <viktor.malmedal@eniro.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2022-12-14 18:28:29 +01:00

1.1 KiB
Raw Blame History

slug
/api/misc/@docusaurus/eslint-plugin/no-html-links

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:

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

<a href="https://twitter.com/docusaurus" target="_blank">Twitter</a>

Examples of correct code for this rule:

import Link from '@docusaurus/Link'

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

<Link to="https://twitter.com/docusaurus">Twitter</Link>

Rule Configuration

Accepted fields:

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