Skip to content

README.md

Latest commit

 

History

History
165 lines (126 loc) · 4.05 KB

README.md

File metadata and controls

165 lines (126 loc) · 4.05 KB
Raw
id MDS053
name no-unused-link-definitions
status ready
description Every `[label]: url` definition must be consumed by at least one reference-style link or image; duplicate labels are flagged.
category link
nature structure
maintainability
markdownlint
id name partial default
MD053
link-image-reference-definitions
false
true
rumdl
id name partial default
MD053
link-image-definitions
false
true
mado
panache
id name partial default
duplicate-reference-labels
duplicate-reference-labels
false
true
id name partial default
unused-definitions
unused-definitions
false
true
obsidian-linter
gomarklint

MDS053: no-unused-link-definitions

Every [label]: url definition must be consumed by at least one reference-style link or image; duplicate labels are flagged.

An unused definition is dead weight. It survives renames, accumulates over time, and masks broken links because mdsmith check never visits the URL unless a *ast.Link node anchors MDS027 to it.

CommonMark renderers silently ignore a duplicate definition — the first wins. The second copy is invisible noise.

Settings

Setting Type Default Description
ignored-labels list [] Normalized labels that are never flagged as unused or duplicate. Replace-mode: a later config layer replaces the entire list.

Config

rules:
  no-unused-link-definitions:
    ignored-labels:
      - comment

Disable:

rules:
  no-unused-link-definitions: false

Examples

Good

# Used Link

See [example][ex] for more.

[ex]: https://example.com

Bad -- unused definition

# Unused

Some plain prose with no links.

[orphan]: https://example.com

Bad -- duplicate definition

# Duplicate

See [foo].

[foo]: https://first.com

[foo]: https://second.com

Diagnostics

Condition Message
unused definition unused link reference definition "label"
duplicate definition duplicate link reference definition "label"; first defined on line N

Auto-fix

Removes the offending definition line. When the line is preceded by a blank line AND also followed by a blank line (or is the last line in the file), the preceding blank line is also removed so removal does not leave a double-blank behind. When only the preceding blank line is present (no following blank), it is preserved so adjacent paragraphs remain separated. Ignored labels are never removed.

See also

Meta-Information