跳转到内容

REF-001 链接断裂

验证 Markdown 中的相对链接(形如 [text](./file.md))指向实际存在的文件。链接目标不存在时,会报告为 error。锚点片段(#section)不参与链接目标判定,其有效性由 REF-005 锚点 负责。

在 Markdown 运维中,因文件重命名、删除、移动导致的链接损坏是最常见的劣化形式。AI 生成时也可能混入指向不存在文件的链接。即便链接断裂,markdownlint 与 CI 仍会通过,因此机械化检测是必要的。

字段类型必填说明
excludestring[]从链接目标验证中排除的路径 glob 数组

省略全部选项也可工作。exclude 用于像外部文档或生成物那样不在 include 范围内、但被有意引用的文件。

详见 [架构](./architecture.md)

./architecture.md 不存在时,判定为违例。

docs/overview.md
line 1 error Link target "./architecture.md" does not exist REF-001
详见 [架构](./architecture.md)

创建链接目标文件 architecture.md,或将链接修正为正确的路径。

{
"rule": "ref001",
"options": {
"exclude": ["generated/**/*.md"]
}
}