Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/errata-ai/Google

A Vale-compatible implementation of the Google Developer Documentation Style Guide.
https://github.com/errata-ai/Google

vale vale-linter-style vale-style

Last synced: 13 days ago
JSON representation

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

Awesome Lists containing this project

README

        

# Google

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

This repository contains a [Vale-compatible](https://github.com/errata-ai/vale) implementation of the [*Google Developer Documentation Style Guide*](https://developers.google.com/style/) ([CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)).

## Getting Started

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

```ini
StylesPath = styles
MinAlertLevel = suggestion

Packages = Google

[*]
BasedOnStyles = Vale, Google
```

See [Packages](https://vale.sh/hub/google/) 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.