Skip to main content

Introduction

Build status Go Report Card GitHub All Releases Docker Pulls

Vale is a command-line tool that brings code-like linting to prose. It's open source, fast, and highly customizable.

๐Ÿ“ It doesn't attempt to teach you how to write; it's a tool for writers. In other words, Vale focuses on allowing its users to create their own collections of rules (known as styles) rather than providing its own advice.

๐Ÿ”’ It's 100% offline, private, and secure. While other tools and services have to explain to you how they will/won't use your data (often in long, legalese-filled documents), all we have to say is that we don't have access to it.

๐Ÿ“ฆ It's a standalone, easy-to-install binary. Unlike other tools, Vale doesn't require you to install and configure a particular programming language and its related tooling (such as Python/pip or Node.js/npm).

Community

Vale has a growing community of users from around the world. Check out the user-contributed resources below.

Connect
GitHub DiscussionsAsk questions, share configurations, and engage in general Vale-related discussion.
GitHub IssuesReport a bug, submit a feature request, or start a PR.
Slack (#testthedocs)Discuss Vale with the Write the Docs community (join here, if you're not already a member).

Have your own video, post, or configuration? Feel free to submit it here.

Users

Homebrew's avatar

Homebrew

An implemetation of a custom, in-house style for the Homebrew docs.
Chef Software, Inc.'s avatar

Chef Software, Inc.

A custom style, vocab, and output format for the Chef reference documentation.
GitHub's avatar

GitHub

A custom style built on top of the Microsoft Writing Style Guide.
Netlify's avatar

Netlify

A custom style and vocab for Netlify CMS website.
Linode's avatar

Linode

A custom configuration for Hugo-powered Markdown docs.
GitLab's avatar

GitLab

An extensive Vale configuration for various GitLab projects.
Backstage's avatar

Backstage

A basic Vale configuration for Spotify's Backstage project.
CockroachDB's avatar

CockroachDB

A custom style for the CockroachDB user documentation.
Eclipse Che's avatar

Eclipse Che

An advanced Vale configuration for the Eclipse Che Documentation.
Write the Docs's avatar

Write the Docs

A custom style for the Write the Docs website.
Mautic's avatar

Mautic

A configuration for the Mautic project based on the Google Developer Documentation Style Guide.
webpack's avatar

webpack

A proselint-based Vale configuration for the webpack website.
Algolia's avatar

Algolia

A fork of the Vale GitHub action maintained by Algolia.
Datadog, Inc.'s avatar

Datadog, Inc.

A custom style for the Datadog documentation.
Rackspace's avatar

Rackspace

A custom style for the Rackspace Expert Insights Technical Blog.
Vaadin's avatar

Vaadin

A custom style and configuration for the Vaadin docs.
Oxygen XML's avatar

Oxygen XML

A Vale Validation add-on for the Oxygen XML editor.
Beyond Code's avatar

Beyond Code

Syntax-aware proofreading for your Laravel application.

Articles

Videos

Privacy

Privacy is an important consideration in all Vale-related development decisions. We've gone to great lengths to ensure that our software has the utmost respect for our users and their content.

For us, it's not merely about what we sayโ€”it's about what we do.

Vale

The Vale command-line tool serves as the foundation (functionality-wise) for all of our software and integrations. It's free, open source, and permissively licensed.

Vale is distributed as a self-contained, standalone binary, and it works entirely offline: We have absolutely zero access to any content linted by Vale.

Vale Server

Vale Server is a graphical user interface (GUI), web-based dashboard, and HTTP server built on top of Vale.

It runs on localhost and uses a local vale executable to perform all of its linting, so it also inherits all of Vale's content-related privacy guarantees.

Integrations

When you use Vale with a third-party integration, you also need to consider their own security and privacy policies.

Wherever possible, we try to abide by the strictest level of security practices. For example, see our blog post, Taking Vale Server to the web, in which we describe how Vale's Chrome extension achieved the very rare distinction of being warning-free according to Google.

Sponsors