markdown-lint

0.0.4 verified Fri May 01 auth: no javascript deprecated

A small CLI tool for linting Markdown files using Remark and Remark-lint under the hood. Version 0.0.4 is the latest stable release. It recursively finds all Markdown files in the current directory using Filehound and applies linting rules. Compared to alternatives like markdownlint-cli, it offers a simple zero-config setup. However, the project appears inactive with no recent updates.

Common errors

error error: unknown option `--help' ↓

cause markdown-lint does not support --help flag

fix

For help, see the GitHub README or use man markdown-lint (if available)

error No such file or directory: /usr/local/lib/node_modules/markdown-lint/node_modules/remark/package.json ↓

cause Corrupted node_modules after incomplete installation

fix

Reinstall with npm uninstall -g markdown-lint && npm install -g markdown-lint

Warnings

deprecated Package is unmaintained; use markdownlint-cli instead. ↓

fix Replace with markdownlint-cli: npm uninstall -g markdown-lint && npm install -g markdownlint-cli

gotcha No configuration options; uses default remark-lint rules. ↓

fix Switch to markdownlint-cli for configurable rules.

gotcha Runs from current directory only; no --path flag. ↓

fix Run from the desired root directory or use markdownlint-cli with --path.

Install

npm install markdown-lint

yarn add markdown-lint

pnpm add markdown-lint

Quickstart

Install globally and run markdown-lint in the target repository to lint all Markdown files recursively.

npm install -g markdown-lint
cd /path/to/your/repo
markdown-lint