Skip to content

Latest commit

 

History

History
37 lines (21 loc) · 799 Bytes

no-missing-label-refs.md

File metadata and controls

37 lines (21 loc) · 799 Bytes

no-missing-label-refs

Disallow missing label references.

Background

Markdown allows you to specify a label as a placeholder for a URL in both links and images using square brackets, such as:

[ESLint][eslint]

[eslint]: https://eslint.org

If the label is never defined, then Markdown doesn't render a link and instead renders plain text.

Rule Details

This rule warns when it finds text that looks like it's a label but the label reference doesn't exist.

Examples of incorrect code:

[ESLint][eslint]

[eslint][]

[eslint]

When Not to Use It

If you aren't concerned with missing label references, you can safely disable this rule.

Prior Art