markdownlint-config-ali/README.md

markdownlint shareable configuration for Alibaba F2E Guidelines

# markdownlint-config-ali

本包提供了《阿里巴巴前端规约 - 文档规约》配套的 [markdownlint 可共享配置](https://www.npmjs.com/package/markdownlint#optionsconfig)。

## 安装

除了本包，你需要同时安装 [markdownlint](https://www.npmjs.com/package/markdownlint)：

```bash
npm install markdownlint-config-ali markdownlint --save-dev
```

## 使用

在 `.markdownlint.json` 中继承本包:

```json
{
  "extends": "./node_modules/markdownlint-config-ali/index.json"
}
```