软件简介

hint 是一个简单的 markdown 静态检查的控制台 cli 工具，可以方便 markdown 开发者轻松集成 travis 自动检测。

一、安装

pip install hint

然后在系统中会得到一个 hint 的命令 cli 工具。

二、使用

使用方法有两种：

2.1 一种是命令行 cli 方式，简单使用方法如下：

hint markdown_file

或者

hint markdown_folder

或者使用 hint --help 查看帮助信息和具体详细的使用方法。

$ hint --help
Usage: hint-script.py [OPTIONS] FILE

Options:
  -i, --ignore TEXT         The error codes which will be ignored.
  -f, --format [text|json]  The output format of error information.
  -m, --max-depth INTEGER   The max depth for traverse the path.
  --help                    Show this message and exit.

可以用于直接集成到各种 ci 系统中，例如 travis-ci。

2.2 另外一种是代码 API 调用的方式，简单使用方法如下：

import hint

text='''
hint 是一个简单的 **markdown** 静态检查的控制台 `cli` 工具。
可以方便 markdown 开发者轻松集成 travis 自动检测。
'''
errors = hint.check(text, ignore='E201')

fn = 'README.md'
errors = hint.check_file(fn, format='text')

可以方便的进行第三方扩展开发。

三、错误码

检查规则来源于 chinese-copywriting-guidelines，错误码命名方式参考于 flake8。目前支持的错误码如下所示：

关于各种错误码的正确、错误范例，可以参考
tests/md。
目前有了大概的代码结构，欢迎 PR 更多的检查错误类型和检查方式 。