前言

在之前的文章我整理了中文 Markdown 的编写规范，但是在日常写作当中，还是避免不了出现一些不满足规范的情况，这个时候就需要一款检查工具。在 Github 上浏览的时候发现了这款 lint-md-cli 命令行工具，基本解决了我的问题。

lint-md-cli 介绍

用于检查中文 markdown 编写格式规范的命令行工具，基于 AST 开发，且方便集成 ci；同时提供 API 方法调用。其检查类型基于阮一峰的中文技术文档写作规范。

安装

 npm i -g lint-md-cli

使用

Usage: <lint-md> <files...> [options]

lint your markdown files

Options:
  -v, --version                  output the version number
  -c, --config [configure-file]  use the configure file, default .lintmdrc
  -f, --fix                      fix the errors automatically
  -h, --help                     output usage information

• 校验 lint

  lint-md README.md Document.md

• 修复 fix

  lint-md README.md Document.md --fix

示例

以本篇文章为例，进行校验和修复效果如下图

回到文中可以看到不规范的地方已经自动修复了

更多使用细节请查看 Github 原项目：https://github.com/lint-md/cli