Skip to content

Z301: DANGLING_REF

  • Severity: Error

    Penalty: 0.0 points | Category: general

  • Remediation & Opt-In

    Auto-Fixable: No | Opt-In: 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:

  • Failing Pattern (Triggers Z301)

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

  • Passing Pattern (Resolves Z301)

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

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

Configuration

.zenzic.toml
# Evaluated automatically during reference link parsing pass

Reference

See the Finding Codes Index for finding code details.