用途:格式化与检查(lint)Markdown 和 MDX 文件,借助 markdownlint 命令行工具,利用对全部 Markdown 规则的理解进行自动化或手动修复。
主要能力:检测并自动修复常见格式问题;识别配置文件;支持指定规则开关与 JSON 输出。
安装与用法:检查是否存在 markdownlint:which markdownlint || which markdownlint;如需安装:pnpm add -D markdownlint 或 npm install -g markdownlint;自动修复全部文件:markdownlint --fix "/.{md,mdx}";检查特定文件:markdownlint README.md docs//.md content//*.mdx;不修复仅检查:markdownlint "/.{md,mdx}";指定配置:markdownlint --config .markdownlint.json "**/.{md,mdx}";禁用规则:markdownlint --disable MD013 MD033 "/*.{md,mdx}";输出 JSON:markdownlint --json "/*.{md,mdx}"。
配置检测顺序:.markdownlint.json、.markdownlint.jsonc、.markdownlint.yaml、.markdownlintrc、package.json 中的 markdownlint 键。
常见问题涵盖标题(MD001、MD018/MD019、MD022、MD025、MD041)、列表(MD004、MD007、MD030、MD032)、空白(MD009、MD010、MD012、MD047)、链接与图片(MD034、MD042、MD045)、代码块(MD031、MD040)。可在 package.json 中添加脚本 lint:md 与 lint:md:fix。限制:资料未提供未涵盖规则、错误码或性能说明。