Skip to content

Broken link checker / linter #18

@tacheraSasi

Description

@tacheraSasi

Feature: Broken Link Checker / Linter

Detect dead internal links, missing images, and orphaned files.

Details

  • New lint subcommand: mdcli lint ./docs
  • Also run automatically during serve startup (with warnings in console)
  • Check for:
    • Broken internal links (references to non-existent .md files)
    • Missing images (referenced images that do not exist)
    • Orphaned files (markdown files not linked from anywhere)
    • Broken anchor links (heading references that do not exist)
  • Output a summary report with file path, line number, and issue type
  • Support --fix flag to auto-remove broken links or suggest corrections
  • Exit with non-zero code if issues found (useful in CI)

Why

Dead links degrade documentation quality. Automated checking catches issues early.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions