Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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.
- Host: GitHub
- URL: https://github.com/errata-ai/Google
- Owner: errata-ai
- License: mit
- Created: 2019-02-13T04:18:13.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-30T01:15:27.000Z (7 months ago)
- Last Synced: 2024-08-01T15:04:54.211Z (3 months ago)
- Topics: vale, vale-linter-style, vale-style
- Language: Gherkin
- Homepage:
- Size: 70.3 KB
- Stars: 70
- Watchers: 6
- Forks: 23
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> **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 = suggestionPackages = 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.