中文 markdown 格式校驗 lint-md v0.1.0，支援 --fix 引數
阿新 • • 發佈：2018-12-31
用於檢查中文 markdown 編寫格式規範的命令列工具，基於 AST 開發，且方便整合 ci；同時提供 API 方法呼叫。Cli tool to lint your markdown file for Chinese.
安裝
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 -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
API 呼叫
import { lint, fix, getDescription } from 'lint-md';
// get the markdown 's style errors
const errors = lint(markdown, rules);
// get the error type description
const describe = getDescription(type[, lang = 'en_US']);
// fix the markdown
const fixed = fix(markdown);lint(markdown, rules)：通過 API 方式來校驗 markdown 文字；
fix(markdown)：通過 API 方式來修復文字；
getDescription(type)：獲取錯誤型別的文字描述，包含多語言；
version：獲得模組的版本號；
其他相關
vscode 外掛：在 vscode 中使用 lint-md 工具。
語雀 lint 服務：利用語雀的 webhook 自動校驗提交的文件格式並做提醒。