About
Vale is a command-line tool that brings code-like linting to prose. It's open-source, fast, and highly customizable.
Your style, our editor#
Vale differs from most writing-related software in a significant way: 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 providing its own advice.
Here are some examples of how Vale is being used by companies, organizations, and open-source projects around the world:
Blog posts & tutorials#
- First steps with the Vale prose linter (Passo.uno)
- Docs as Code at Linode (Linode)
- Linting the Buildkite Docs (Buildkite)
- Sofie's Docs Diary Vol. 16: Writing in style (Umbraco)
- Automated Enforcement of our Style Guide (Drupalize.Me)
- Documentation as code: A Linting How To - The Vale Linter in action (Demo) (Tag1)
- How to Improve DocOps using CI/CD and Docs-as-Code (Pronovix)
- Vale for Spelling, Grammar, Style and Readability Linting (DZone)
- Testing your Documentation (Write the Docs)
Open-source configurations#
| Repository | Configuration |
|---|---|
gitlab-org/gitlab | .vale.ini, StylesPath |
linode/docs | .vale.ini, StylesPath |
Homebrew/brew | .vale.ini, StylesPath |
spotify/backstage | .vale.ini, StylesPath |
cockroachdb/docs | .vale.ini, StylesPath |
github/codeql | .vale.ini, StylesPath |
netlify/netlify-cms | .vale.ini, StylesPath |
Sponsors#
Hi there! I'm @jdkato, the sole developer of Vale. If you'd like to help me dedicate more time to developing, documenting, and supporting Vale, feel free to donate through the Open Collective. Any donation—big, small, one-time, or recurring—is greatly appreciated!
