Skip to content

Add markdown-link-check with pre-commit to check for dead links in Markdown files #11290

Open

Description

@jbampton

https://github.com/tcort/markdown-link-check

https://github.com/tcort/markdown-link-check?tab=readme-ov-file#run-as-a-pre-commit-hook

- repo: https://github.com/tcort/markdown-link-check
  rev: ...
  hooks:
    - id: markdown-link-check
      args: [-q]

We will need a config file with various rules:

https://github.com/tcort/markdown-link-check?tab=readme-ov-file#config-file-format

Activity

  1. added theissue type on Jul 24, 2025
  2. added this to the 4.22.0 milestone on Aug 19, 2025
  3. github-actions commented on Apr 14, 2026

    @github-actions

    🏷️ Issue Triaged

    Hi @jbampton! I've categorized this issue as enhancement based on the following analysis:

    Reasoning: This proposes adding a new pre-commit hook (markdown-link-check) to improve documentation quality by detecting broken links in Markdown files. This is a tooling enhancement that would improve the development workflow.

    View Triage Details

    Analysis

    • Keywords detected: pre-commit, check, markdown, tool integration
    • Issue type indicators: Proposes adding a new development tool/hook, includes configuration examples, references external tooling documentation
    • Confidence: High

    Recommended Next Steps

    • Define configuration rules for the link checker to avoid false positives
    • Consider running an initial check to identify the current state of broken links
    • Coordinate with documentation maintainers on implementation timeline

    References: Triage run §24405385343

    Generated by Issue Triage Agent

    To install this workflow, run gh aw add github/gh-aw/.github/workflows/issue-triage-agent.md@94662b1dee8ce96c876ba9f33b3ab8be32de82a4. View source at https://github.com/github/gh-aw/tree/94662b1dee8ce96c876ba9f33b3ab8be32de82a4/.github/workflows/issue-triage-agent.md.

  4. removed this from the 4.22.1 milestone on Apr 23, 2026
  5. added this to the unplanned milestone on May 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions