https://github.com/chrischinchilla/openly

A Vale linter style that aims to replicate Grammarly in an open-source, privacy-friendly way
https://github.com/chrischinchilla/openly

hacktoberfest vale-linter-style

Last synced: 12 months ago
JSON representation

A Vale linter style that aims to replicate Grammarly in an open-source, privacy-friendly way

• Host: GitHub
• URL: https://github.com/chrischinchilla/openly
• Owner: ChrisChinchilla
• License: mit
• Created: 2019-12-27T20:29:49.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-12-27T10:06:25.000Z (over 1 year ago)
• Last Synced: 2025-06-09T05:47:43.516Z (about 1 year ago)
• Topics: hacktoberfest, vale-linter-style
• Language: Gherkin
• Homepage:
• Size: 44.9 KB
• Stars: 141
• Watchers: 10
• Forks: 9
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# Openly - Open source Grammarly

A Vale linter style that attempts to emulate some features of the commercial, and closed source, Grammarly. More to come.

__Not complete, and WIP, contributions welcome__.😁

[![Build Status](https://travis-ci.org/testthedocs/Openly.svg?branch=master)](https://travis-ci.org/testthedocs/Openly) ![Vale version](https://img.shields.io/badge/vale-%3E%3D%20v1.7.0-blue.svg) ![license](https://img.shields.io/github/license/mashape/apistatus.svg)

This repository contains a [Vale-compatible](https://github.com/errata-ai/vale) that attempts to emulate some features of the commercial, and closed source, Grammarly. More to come.

## Getting Started

> :exclamation: Requires Vale >= **1.7.0**. :exclamation:

Download the [latest release](https://github.com/testthedocs/Openly/releases), copy the "Openly" 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 = Openly

```

See [Usage](https://github.com/errata-ai/vale/#usage) for more information.