用于检查中文 markdown 编写格式规范的命令行工具,基于 AST 开发,且方便集成 ci。Cli tool to lint your markdown file for Chinese.
开源地址:https://github.com/hustcc/lint-md
npm i -g lint-md
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
-h, --help output usage information
Example:
lint-md README.md Document.md
检查规则来源于 chinese-copywriting-guidelines.
| 规则 | 详细描述 | 解决办法 | | ------ | ------ | ------ | | space-between | 中文与英文数字之间需要增加空格 | 响应位置增加空格 | | no-empty-code-lang | 代码语言不能为空 | 在代码块语法上增加语言 | | no-empty-url | 链接和图片地址不能为空 | 填写完整的 url,或者不使用链接和图片语法 | | no-empty-list | List 内容不能为空 | List 语法中,填写内容 | | no-empty-code | 代码块内容不能为空 | 删除空的代码块,或者填充代码内容 | | no-empty-blockquote | blockquote 内容不能为空 | 删除空的 blockquote,或者填充内容 | | no-special-characters | 文本中不能有特殊字符 | 可能是复制出来的特殊字符,删除特殊字符即可 |
目前仅仅检查了比较通用的类型,欢迎 pull request,在
rules
中增加自己的规则,开发约束:
默认所有的规则都是 error
类型,但是可以通过配置来指定规则类型。示例 .lintmdrc
:
{
"excludeFiles": [],
"rules": {
"no-empty-code": 1
}
}
通过 rules 来配置规则的等级。
通过 excludeFiles 来忽略文件和目录,glob 语法。
在
.travis.yml
文件中配置以下内容。
language: node_js
node_js:
- "10"
before_install:
- npm i -g lint-md
script: lint-md README.md
在
package.json
中增加以下配置。
"lint-staged": {
"src/**/*.{md,markdown}": [
"lind-md"
]
}
MIT@hustcc.
1
Showfom 2018-11-23 16:03:04 +08:00 via iPhone
支持一下
|
2
lonelinsky 2018-11-23 16:18:49 +08:00
目前在用 VSCode 的 markdownlint,表示很好用,支持。
|
3
50vip OP @lonelinsky 我是希望多加一些中文的格式校验,所以做了 lint-md,用于写文章,写博客,优化排版!
|
4
50vip OP @lonelinsky 这个的好处就是可以在 ci 中使用,这样大家 pr 的时候,都可以按照这么标准来!
|
5
lonelinsky 2018-11-23 16:55:28 +08:00
@50vip #3 是指「中文文案排版指北」这样的排版规范吗?我当时用它里面提供的排版工具排版了下我的博客,然后因为 Hexo 的一些特殊要求,导致博客直接崩了,后来又重新手动修正了下 =。=
|
6
50vip OP |
7
chungzhao 2018-11-24 15:50:39 +08:00
真棒!!!
|
8
chungzhao 2018-11-24 16:01:21 +08:00
可以批量检测吗?
|