jdkato/vale repository overview

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.

⁠Usage

Vale requires three components: a .vale.ini config file, a StylesPath directory (specified in the config file), and a document or directory to lint. Here's an example of calling Vale with locally-defined components (assuming $(pwd)/fixtures/styles/demo contains a config file):

$ docker run --rm -v $(pwd)/styles:/styles \
             --rm -v $(pwd)/fixtures/styles/demo:/docs \
             -w /docs \
             jdkato/vale .