Skip to content
forked from errata-ai/Google

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

License

Notifications You must be signed in to change notification settings

jessetan/Google

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Google Build Status Vale version license

This repository contains a Vale-compatible implementation of the Google Developer Documentation Style Guide.

The goal is to showcase how to build and maintain a full-featured style guide for Vale, including many examples of using extension points and a test suite using Cucumber, yamllint, and Travis CI.

Getting Started

❗ Google requires Vale >= 1.0.0. ❗

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

See Usage for more information.

Repository Structure

/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.

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Gherkin 95.6%
  • Ruby 4.4%