lint-md-cli

0.1.2 verified Fri May 01 auth: no javascript

A command-line tool for linting Chinese markdown files based on AST. Current stable version 0.1.2. Developed by hustcc, it integrates with CI pipelines and Docker. Supports configuring rule severity and excluding files via .lintmdrc. Key differentiator: focused on Chinese writing conventions, built on lint-md package, no breaking changes reported.

Common errors

error bash: lint-md: command not found ↓

cause Package not installed globally.

fix

Run npm install -g lint-md-cli

error Error: Cannot find module 'lint-md' ↓

cause Missing dependency lint-md, not installed automatically.

fix

Run npm install lint-md (use lint-md package) alongside lint-md-cli

error Unknown option: --fix ↓

cause Older version without fix support; or misspelled option.

fix

Upgrade to latest version (0.1.2) and use --fix as shown in help.

Warnings

gotcha Global install required for CLI use; not found when installed locally. ↓

fix Install globally via npm i -g lint-md-cli or use npx lint-md-cli.

gotcha Rules configured in .lintmdrc must match lint-md package rules exactly. ↓

fix Refer to https://github.com/hustcc/lint-md/tree/master/packages/lint-md for valid rule names.

deprecated The package may not be actively maintained; last update 2020. ↓

fix Consider alternatives like markdownlint or remark-lint for broader support.

Install

npm install lint-md-cli

yarn add lint-md-cli

pnpm add lint-md-cli

Quickstart

Install globally, then lint or fix markdown files with options for config and auto-fix.

npm install -g lint-md-cli
# Check single file
lint-md README.md
# Check multiple files
lint-md README.md Document.md
# Fix automatically
lint-md README.md --fix
# Custom config
lint-md README.md -c .lintmdrc