Write Better with Vale

Lint your docs like code: turn any style guide into enforceable rules with Vale and publish clear, consistent content every time.

When you work on a content project, keeping things consistent can feel impossible. Typos slip through, people don’t follow style rules, and each contributor brings a slightly different voice. Vale helps you ensure consistency across your content.

You’ll start by catching typos as you learn how Vale works through hands-on examples. Then you’ll bring in community rules based on Google’s and Microsoft’s style guides. You’ll combine overlapping styles, adjust the rules to match your needs, and start shaping the experience you want readers to have. Then you’ll build your own rules from scratch and create a custom vocabulary to teach Vale to enforce your team’s voice and jargon. By the end, you’ll have a fully integrated, reusable style package that works in your editor, GitHub Actions, and your build systems. And while this book uses Markdown in its examples, you’ll be ready to apply everything you learned to reStructuredText, AsciiDoc, and even the comments in your source code.

Vale gives you a fast, reliable, and customizable way to keep your content consistent.

What You Need:

This book uses Vale 3.12.0 or higher. You’ll need a text editor like Visual Studio Code or Vim. You should be familiar with basic regular expressions, and be comfortable working with command-line tools and Markdown.