testthedocs / JQuery

A Vale linter style that replicates the JQuery style guide
MIT License
2 stars 1 forks source link
vale-linter-style

JQuery

A Vale linter style that replicates the jQuery Prose Style Guide.

Not complete, and WIP, contributions welcome.😁

Build Status Vale version license

This repository contains a Vale-compatible implementation of the guidelines enforced by the JQuery Prose Style Guide.

Getting Started

:exclamation: Requires Vale >= 1.7.0. :exclamation:

Download the latest release, copy the "JQuery" 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 = JQuery

See Usage for more information.