Need more than a rule playground?

Explore Vale CMS
Package Explorer

Google

A Vale-compatible implementation of the Google Developer Documentation Style Guide.

Source style

Getting started

Add it to your .vale.ini, then run vale sync.

Packages = Google

[*.md]
BasedOnStyles = Vale, Google

Rules 31

15 error11 warning5 suggestion
  • Google.Acronyms suggestion conditional Style guide

    Spell out '%s', if it's unfamiliar to the audience.

  • Google.AMPM error existence Style guide

    Use 'AM' or 'PM' (preceded by a space).

  • Google.Colons warning existence scope: sentence Style guide

    '%s' should be in lowercase.

  • Google.Contractions suggestion substitution Style guide

    Use '%s' instead of '%s'.

  • Google.DateFormat error existence Style guide

    Use 'July 31, 2016' format, not '%s'.

  • Google.Ellipses warning existence Style guide

    In general, don't use an ellipsis.

  • Google.EmDash error existence Style guide

    Don't put a space before or after a dash.

  • Google.Exclamation error existence Style guide

    Don't use exclamation points in text.

  • Google.FirstPerson warning existence Style guide

    Avoid first-person pronouns such as '%s'.

  • Google.Gender error existence Style guide

    Don't use '%s' as a gender-neutral pronoun.

  • Google.GenderBias error substitution Style guide

    Consider using '%s' instead of '%s'.

  • Google.HeadingPunctuation warning existence scope: heading Style guide

    Don't put a period at the end of a heading.

  • Google.Headings warning capitalization scope: heading Style guide

    '%s' should use sentence-style capitalization.

  • Google.Latin error substitution Style guide

    Use '%s' instead of '%s'.

  • Google.LyHyphens error existence Style guide

    '%s' doesn't need a hyphen.

  • Google.OptionalPlurals error existence Style guide

    Don't use plurals in parentheses such as in '%s'.

  • Google.Ordinal error existence Style guide

    Spell out all ordinal numbers ('%s') in text.

  • Google.OxfordComma warning existence scope: sentence Style guide

    Use the Oxford comma in '%s'.

  • Google.Parens suggestion existence Style guide

    Use parentheses judiciously.

  • Google.Passive suggestion existence Style guide

    In general, use active voice instead of passive voice ('%s').

  • Google.Periods error existence Style guide

    Don't use periods with acronyms or initialisms such as '%s'.

  • Google.Quotes error existence Style guide

    Commas and periods go inside quotation marks.

  • Google.Ranges warning existence Style guide

    Don't add words such as 'from' or 'between' to describe a range of numbers.

  • Google.Semicolons suggestion existence scope: sentence Style guide

    Use semicolons judiciously.

  • Google.Slang error existence Style guide

    Don't use internet slang abbreviations such as '%s'.

  • Google.Spacing error existence Style guide

    '%s' should have one space.

  • Google.Spelling warning existence Style guide

    In general, use American spelling instead of '%s'.

  • Google.Units error existence Style guide

    Put a nonbreaking space between the number and the unit in '%s'.

  • Google.We warning existence Style guide

    Try to avoid using first-person plural like '%s'.

  • Google.Will warning existence Style guide

    Avoid using '%s'.

  • Google.WordList warning substitution Style guide

    Use '%s' instead of '%s'.