NOTE: This project is neither maintained nor endorsed by Google.

This repository contains a Vale-compatible implementation of the Google Developer Documentation Style Guide (CC BY 4.0).

To get started, add the package to your configuration file (as shown below) and then run vale sync.

StylesPath = styles
MinAlertLevel = suggestion

Packages = Google

[*]
BasedOnStyles = Vale, Google

See Packages for more information.

/Google

The YAML-based rule implementations that make up our style.

/fixtures

The individual unit tests. Each directory should be named after a rule found in /Google and include its own .vale.ini file that isolates its target rule.

/features

The Cucumber Step Definitions we use to test our fixtures. Essentially, we use the aruba framework to test Vale's output after running it on each of our fixture directories.