Skip to content

Latest commit

 

History

History
24 lines (16 loc) · 1.3 KB

README.md

File metadata and controls

24 lines (16 loc) · 1.3 KB
Raw

proselint Build Status Vale version license

proselint places the world’s greatest writers and editors by your side, where they whisper suggestions on how to improve your prose.

This repository contains a Vale-compatible implementation of the guidelines enforced by the proselint (LICENSE) linter.

Getting Started

❗ proselint requires Vale >= 1.7.0. ❗

Download the latest release, copy the "proselint" directory to your StylesPath, and include it in your configuration file:

# This goes in a file named either `.vale.ini` or `_vale.ini`.
StylesPath = path/to/some/directory
MinAlertLevel = warning # suggestion, warning or error

# Only Markdown and .txt files; change to whatever you're using.
[*.{md,txt}]
# List of styles to load.
BasedOnStyles = proselint

See Usage for more information.