Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

lint-md #98

Closed
hustcc opened this issue Nov 21, 2018 · 6 comments
Closed

lint-md #98

hustcc opened this issue Nov 21, 2018 · 6 comments

Comments

@hustcc
Copy link

hustcc commented Nov 21, 2018

用于检查中文 markdown 编写格式规范的命令行工具,基于 AST 开发,且方便扩展和集成 ci。

地址: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      

也推荐在这个 weekly 中用起来!

  • Travis

在 .travis.yml 文件中配置以下内容。

language: node_js
node_js:
  - "10"
before_install:
  - npm i -g lint-md
script: lint-md ./doc
@Ir1d
Copy link

Ir1d commented Nov 21, 2018

我在用 remark-lint 体验也不错

@hustcc
Copy link
Author

hustcc commented Nov 21, 2018

lint-md 会比较关注中文 markdown 编辑一些。

@ruanyf
Copy link
Owner

ruanyf commented Nov 25, 2018

很不错的工具。建议中文与数字之间的空格为可选。

收入第 36 期。

@hustcc
Copy link
Author

hustcc commented Nov 25, 2018

@ruanyf 可以通过配置工具,自定义将规则设置为等级,类似于 eslint,设置 0,1,2

0:忽略
1:警告,不阻断 ci
2:错误,会阻断 ci

@ruanyf
Copy link
Owner

ruanyf commented Nov 25, 2018

我的意思是将字母的空格与数字的空格分开,现在是一条规则,可以分成两条规则。

可以参考这份周刊遵循的《中文技术文档写作规范》https://github.com/ruanyf/document-style-guide/blob/master/docs/text.md

@hustcc
Copy link
Author

hustcc commented Nov 25, 2018

好的,这个当时也在犹豫要不要分开。

后面也按照这份文档添加一些规则。

@hustcc hustcc closed this as completed Feb 13, 2019
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants