Z301: DANGLING_REF

Severity: warning Penalty: 4.0 points Category: navigation Auto-fixable: No

Rationale¶

This rule is emitted when a Markdown reference link (for example, [heading][my-ref]) uses a shortcut label [my-ref] that has no matching definition [my-ref]: URL anywhere in the document.

How to Fix¶

Inspect the flagged location in the Markdown file and update the content or configuration:

Bad (Triggers Z301)¶

<!-- BAD: [install-guide] shortcut has no definition at bottom -->
Follow our [Installation Guide][install-guide] to begin.

Good (Resolves Z301)¶

<!-- GOOD: Include matching reference definition line -->
Follow our [Installation Guide][install-guide] to begin.

[install-guide]: ../how-to/install.md

Configuration¶

# Evaluated automatically during reference link parsing pass

Reference¶

See the Finding Codes Index for finding code details.