/styles

:package: A collection of pre-packaged, Vale-compatible style guides ready to be installed from your Vale Server dashboard!

Primary LanguagePythonMIT LicenseMIT

Styles Build Status

This repository contains a library of all officially supported styles for Vale and Vale Server.

Vale Vale Server
Vale is an open-source, command-line linter for prose. It's fast, syntax-aware, and extensible. Vale Server is a commercial desktop application (macOS and Windows) that enhances and refines the Vale experience.

The benefits of using these styles over their original implementations include:

  • Improved support for markup, including the ability to ignore code and target only certain sections of text (e.g., checking headers for a specific capitalization style).
  • No need to install and configure npm (Node.js), pip (Python), or other language-specific tools. With Vale, you get all the functionality in a single, standalone binary available for Windows, macOS, and Linux.
  • Easily combine, mismatch, or otherwise customize each style.

Available styles

Microsoft
An implementation of the Microsoft Writing Style Guide.
Google
An implementation of the Google Developer Documentation Style Guide.
write-good
An implementation of the guidelines enforced by the write-good linter.
proselint
An implementation of the guidelines enforced by the proselint linter.
Joblint
An implementation of the guidelines enforced by the Joblint linter.

Requirements

All styles in this library must (1) be maintained in their own (dedicated) repository, (2) publish releases following Semantic Versioning, and (3) include a meta.json file with the following structure:

{
  // An Atom-formatted release feed:
  //
  // e.g., https://github.com/<USER>/<REPO>/releases.atom
  "feed": "...",
  // The minimum required Vale version:
  //
  // e.g., v1.0.0
  "vale_version": "..."
}

Submitting a style

Fork this repo, add an entry (in alphabetical order) to the library.json file, and submit a PR.