vale

README

Vale: Your Style, Our Editor

Vale is a natural language linter that supports plain text, markup (Markdown, reStructuredText, AsciiDoc and HTML) and source code comments. Vale doesn't attempt to offer a one-size-fits-all collection of rules—instead, it strives to make customization as easy as possible.

Check out project website to learn more!

Features

• Supports Markdown, reStructuredText, AsciiDoc, HTML, and source code
• Extensible through straightforward YAML files
• Standalone binaries for Windows, macOS, and Linux
• Expressive, EditorConfig-like configuration

Installation

macOS

Install through Homebrew:

$ brew tap ValeLint/vale
$ brew install vale

Manually install for Windows, macOS and Linux

Download and install an executable from the releases page.

Usage

CLI

$ vale README.md

Run vale --help for more information.

Integrations

• Atom
• Sublime Text