Vale CMS Need more than a rule playground? Explore

Config generator

Build your .vale.ini

Pick what you write, then the styles to hold it to. Counts are from 55 public configs across 90 projects.

Markdown

Source files. Only the comments are linted, with the same styles.

Data files and conventions. A View says which fields are prose, and is written for you.

Skips Hugo shortcodes and other non-standard markup.
+ An extension of your own, read as one of these
read as

Base style

A published guide to build on. Vale's own rules run either way; pick none to keep only those.

Google’s developer documentation style: second person, active voice, sentence-case headings, plain words.

15 error 12 warning 9 suggestion · used by 8 of 55

Rules Source

Microsoft’s writing style: warm and direct, contractions welcome, no jargon.

20 error 12 warning 15 suggestion · used by 6 of 55

Rules Source

Red Hat’s documentation style: precise terminology and consistent formatting for technical content.

5 error 13 warning 19 suggestion · used by 2 of 55

Rules Source

Elastic’s documentation style, written for product and reference docs.

1 error 15 warning 16 suggestion

Rules Source

Salesforce’s documentation style, written for product help and reference.

5 error 23 suggestion

Rules Source

Supplementary styles

Single-purpose checks that sit on top of any base. Add as many as you like.

Weasel words, passive voice, clichés, and other loose writing.

2 error 5 warning 1 suggestion · used by 8 of 55

Rules Source

Redundancy, jargon, dated phrases, and other common style slips.

27 error 7 suggestion · used by 4 of 55

Rules Source

Insensitive or inconsiderate wording, with gentler alternatives.

1 error 10 warning · used by 1 of 55

Rules Source

Biased or exclusionary language in job posts.

5 error 6 warning 6 suggestion

Rules Source

Exclusionary language, and the inclusive terms to use instead.

13 warning

Rules Source

Reading-level scores, so a hard passage is flagged rather than guessed at.

7 suggestion

Rules Source

Report everything. The loudest setting, and the usual starting point.

StylesPath = styles

MinAlertLevel = suggestion

# Markdown.
[*.md]
BasedOnStyles = Vale