https://github.com/jeasonstudio/cnlint

Lint tool for markdown with Simplified Chinese and English
https://github.com/jeasonstudio/cnlint

Last synced: 8 months ago
JSON representation

Lint tool for markdown with Simplified Chinese and English

• Host: GitHub
• URL: https://github.com/jeasonstudio/cnlint
• Owner: jeasonstudio
• License: mit
• Created: 2019-04-30T06:46:44.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-05-22T13:36:46.000Z (over 6 years ago)
• Last Synced: 2025-01-31T14:15:34.937Z (8 months ago)
• Language: JavaScript
• Size: 986 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
🚒 CNLint


Lint tool for markdown with Simplified Chinese and English.
中英文混合排版的 Markdown Lint 工具。


## Tutorial

Please see: [Markdown 简体中文与西文混排要点](https://www.yuque.com/jeason/box/ispdnv)

## Install

```sh

$ npm install -g cnlint

```

## Usage

```sh

$ cnlint -h

  Usage: cnlint [options] [command]

  

  Commands:

    help     Display help

    version  Display version

  

  Options:

    -d, --debug [value]  Show debug log (defaults to "false")

    -h, --help           Output usage information

    -r, --rule           Use local `**.js` file as new rule.

    -v, --version        Output the version number

  

  Examples:

    - Lint all markdown files pwd.

    $ cnlint ./**/*.md

    - Lint multiple markdown files.

    $ cnlint ./demo1.md ./demo2.md

    - Show debug logs when lint files.

    $ cnlint --debug=true ./example.md

    - Use local rule to lint. See: https://github.com/DavidAnson/markdownlint/blob/master/doc/CustomRules.md

    $ cnlint --rule=./my-rule.js

```

![demo](images/demo.jpg)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjeasonstudio%2Fcnlint.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjeasonstudio%2Fcnlint?ref=badge_shield)

## License

[MIT](LICENSE)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjeasonstudio%2Fcnlint.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjeasonstudio%2Fcnlint?ref=badge_large)