eslint-plugin-markdown-links

Appearance

markdown-links/no-dead-urls ​

disallow dead external link urls

📖 Rule Details ​

This rule checks external HTTP/HTTPS links in Markdown files and reports any that are dead or return error responses.

This rule is heavily inspired by remark-lint-no-dead-urls, and many of its options are based on that library.

md
<!-- eslint markdown-links/no-dead-urls: 'error' -->

<!-- ✓ GOOD -->

[Working link](https://www.google.com)

[GitHub][github]

[github]: https://github.com

<!-- ✗ BAD -->


[Dead link](https://this-domain-does-not-exist-12345.com)



[404 link](https://httpstat.us/404)



[broken]: https://non-existent-domain.example

🔧 Options ​

json
{
  "markdown-links/no-dead-urls": [
    "error",
    {
      "ignoreLocalhost": true,
      "ignoreUrls": [],
      "checkAnchor": true,
      "allowedAnchors": { "/./": "/^:~:/" },
      "maxRedirects": 5,
      "maxRetries": 1,
      "timeout": 3000
    }
  ]
}
  • ignoreLocalhost (type: boolean, default: true): Ignore links to localhost/127.0.0.1/0.0.0.0/::1.
  • ignoreUrls (type: string[], default: []): List of URL patterns (string or RegExp) to ignore. When specifying a regular expression, use a string that looks like a regular expression literal, e.g., "/\\/foo/u". Note that since it is a string, you need to double-escape backslashes. To avoid this, it is recommended to use String.raw`/\foo/u`.
  • checkAnchor (type: boolean, default: true): Also check anchor fragments (the part after #) in URLs.
  • allowedAnchors (type: Record<string, string>, default: { "/./u": "/^:~:/u" }): A mapping of URL patterns to anchor fragment patterns (both as strings or regular expressions). Any anchor fragment matching the pattern for the given URL will always be considered valid, even if not present on the target page. You can also use regular expression strings for both URL and fragment.
  • maxRedirects (type: integer, default: 5): Maximum number of redirects to follow when checking a link.
  • maxRetries (type: integer, default: 1): Maximum number of retry attempts for each link check.
  • timeout (type: integer, default: 3000): Timeout in milliseconds for each link check.

📚 Further Reading ​

🚀 Version ​

This rule was introduced in eslint-plugin-markdown-links v0.1.0

🔍 Implementation ​