Skip to content

sapegin/proselint

Repository files navigation

proselint

npm Build Status

Proselint wrapper with a friendly reporter. Also skips text in Markdown code blocks.

Proselint

Installation

macOS

brew install proselint
npm install -g proselint

Other platforms

pip install proselint
npm install -g proselint

Usage

proselintjs filename.md
proselintjs *.md
proselintjs 'pattern/**/*.md'

Configuration

You can disable any rule in ~/.proselintrc:

{
  "checks": {
    "typography.diacritical_marks": false
  }
}

See the original proselint docs for more details.

Changelog

The changelog can be found on the Releases page.

Contributing

Everyone is welcome to contribute. Please take a moment to review the contributing guidelines.

Authors and license

Artem Sapegin and contributors.

MIT License, see the included License.md file.