https://github.com/errata-ai/readability
Vale-compatible implementations of many popular "readability" metrics.
https://github.com/errata-ai/readability
vale-linter-style vale-style
Last synced: 3 months ago
JSON representation
Vale-compatible implementations of many popular "readability" metrics.
- Host: GitHub
- URL: https://github.com/errata-ai/readability
- Owner: errata-ai
- License: mit
- Created: 2021-11-14T21:46:01.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-31T20:20:24.000Z (over 2 years ago)
- Last Synced: 2025-03-26T19:05:54.184Z (3 months ago)
- Topics: vale-linter-style, vale-style
- Language: Go
- Homepage:
- Size: 12.7 KB
- Stars: 16
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Readability
This repository contains a [Vale-compatible][1] implementation of many popular
"readability" metrics.
## Getting Started
> :exclamation: Readability requires Vale >= **2.13.0**. :exclamation:
Download the [latest release][2], copy the "Readability" directory to your
`StylesPath`, and include it in your configuration file:
```ini
# 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 = Readability
```
See [Usage][3] for more information.
[1]: https://github.com/errata-ai/vale
[2]: https://github.com/errata-ai/readability/releases
[3]: https://github.com/errata-ai/vale/#usage