Skip to content

Z101: LINK_BROKEN

  • Severity: Error

    Penalty: 0.0 points | Category: general

  • Remediation & Opt-In

    Auto-Fixable: No | Opt-In: No

Rationale

This rule validates every relative Markdown link against the Virtual Site Map (VSM) rather than just checking filesystem disk presence. A finding is emitted when a target page does not exist in the VSM or is unserved by the build engine.

Linking to non-existent target files or unrendered routes produces broken HTTP 404 navigation errors for end users upon site publication.

How to Fix

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

  • Failing Pattern (Triggers Z101)

    docs/example.md
    <!-- BAD: Linking to a non-existent file or route -->
Please refer to our [Installation Guide](../setup/installation.md) for details.

  • Passing Pattern (Resolves Z101)

    docs/example.md
    <!-- GOOD: Linking to an existing, served page in the VSM -->
Please refer to our [Installation Guide](../how-to/install.md) for details.

Configuration

.zenzic.toml
# .zenzic.toml - Exclude specific external domain URLs from broken link checks
excluded_external_urls = [
    "https://github.com/PythonWoods/zenzic",
]

Reference

See the Finding Codes Index for finding code details.