关于 md-lint
md-lint 是用于 Markdown 文档的格式整理与规范检查技能,适合希望统一文档风格的编写者。它通过编辑后钩子运行 markdownlint-cli2 和 Prettier,并区分自动修复项与需手动处理的规则。
主要功能
- 01自动运行 Markdown 格式化
- 02修复常见 Markdown 规范问题
- 03列出需手动修正的规则
- 04说明符合规范的写作约定
适用场景
- 01编辑后统一 Markdown 格式
- 02检查标题、空白和链接问题
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ jimweller/ clanker-skills --skill md-lint安装后在 Claude Code 中输入/md-lint确认已加载。
详细介绍
STARTER_CHARACTER = 🔏
Markdown 格式化约定
每当写入或编辑 Markdown 文件时,PostToolUse 钩子都会运行 markdownlint-cli2 --fix,然后运行 prettier --write,但 .llmtmp/、.llmdocs/、SKILL.md 和计划文件除外。写入此约定文件可以避免重写,而重写会使文件的上下文副本失效。
Prettier 会重写的内容
| 输入 | 输出 |
|---|---|
* item, + item | - item |
1) 有序列表标记 | 1. |
*emphasis* | _emphasis_ |
__strong__ | **strong** |
*** 分隔线 | --- |
| 两个或更多空行 | 一个空行 |
| 行内连续空格 | 单个空格 |
| 未填充的表格单元格 | 按列宽填充的单元格 |
| 没有结尾换行符 | 添加结尾换行符 |
不会重新换行正文。长行保持原样。
markdownlint 会修复的内容
# 后缺少空格、标题和围栏代码块周围缺少空行、尾随空白,以及裸 URL。
以下四条规则已关闭:MD013(行长)、MD024(重复标题)、MD029(有序列表前缀)、MD033(行内 HTML)。
两者都无法修复的内容
这些会作为钩子反馈传递给模型,需要手动编辑:
- MD003,标题样式。使用
===或---下划线标记的 Setext 标题属于错误。请使用 ATX(#、##)。 - MD025,每个文档只能有一个 H1。
- MD045,图片需要替代文本。
- MD042,链接需要目标地址。
- MD040,围栏代码块需要指定语言。
编写符合规范的 Markdown
以单个 # Title 开头。使用 ATX 标题、- 项目符号、_强调_、**加粗**,在区块间留一个空行,为每个围栏代码块指定语言,为每张图片添加替代文本,并以换行符结尾。
评论
支持 Markdown