Proselint wrapper with a friendly reporter
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
.editorconfig
.eslintignore
.eslintrc
.gitignore
.travis.yml
Contributing.md
License.md
Readme.md
package.json
yarn.lock

Readme.md

proselint

npm Build Status

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

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.