Vale is an open source prose linter that can check the content of documents in several formats against style guide rules. The goal of a prose linter is automating style guide checks in docs-as-code environments, so it detects style issues before deployment or while you edit documentation in a code editor.
This repo contains a set of linting rules for Vale based on the Google style guide and MapTiler style guide.
Note
This repo is a fork of https://github.com/errata-ai/Google. This way, you can synchronize changes to the Google style guide.
Warning
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 = vale-styles
MinAlertLevel = suggestion
Packages = https://github.com/maptiler/vale-rules/releases/latest/download/Google.zip, https://github.com/maptiler/vale-rules/releases/latest/download/MapTiler.zip
[*.{md}]
BasedOnStyles = Vale, Google, MapTiler See Packages for more information.
/Google- The YAML-based in Google rule implementations with modifications that make up our style.
/MapTiler- The YAML-based in Google rule implementations that make up our style.
/fixtures- The individual unit tests. Each directory should be named after a rule found in
/Googleand include its own.vale.inifile 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.