Lint your docs like code: turn any style guide into enforceable rules with Vale and publish clear, consistent content every time.
Create consistent content that gives readers confidence with Vale, the open-source prose linter that helps you enforce your style guide automatically. Use battle-tested rules based on freely available, popular style guides, apply your brand's terms with a custom vocabulary, and integrate Vale into your text editor, Git hooks, and CI pipeline. Catch typos and inclusive-language issues before they ship, and spend your energy on shaping ideas instead of fixing copy. Whether you're a technical writer working in a docs-as-code environment, or a software engineer who occasionally writes, you'll ship clean, consistent copy 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.
Table of Contents:
- Preface
- Getting Started with Vale
- Installing Vale
- Setting Up Vale on your Project
- Checking Multiple Formats
- Getting Insight into Vale’s Configuration
- Using Different Configuration Files
- Overriding Files to Scan
- Your Turn
- Wrapping Up
- Using Existing Style
- Downloading Existing Styles with Vale
- Adding a Complementary Style
- Checking for Readability, Profanity, and Inconsiderate Writing
- Filtering Results
- Your Turn
- Wrapping Up
- Building Your Own Style
- Creating a New Style
- Ensuring Something Exists in the Document
- Enforcing Capitalization
- Linting Front Matter
- Incorporating and Managing Existing Rules
- Enforcing Word Usage
- Enforcing Grammar with Natural Language
- Your Turn
- Wrapping Up
- Integrating Vale into Your Workflow
- See Errors As You Work
- Linting Comments in Source Code
- Writing Custom Rules with Scripts
- Working with Custom Formats
- Sharing Your Style Across Multiple Projects
- Using Vale with GitHub Actions
- Your Turn
- Wrapping Up
- Resources Referenced
About the Author :
Brian P. Hogan is a technical content expert, open source software developer, educator, author, editor, and musician with more than 15 years of experience developing and leading technical documentation and developer education programs at DigitalOcean, Temporal Technologies, and Tailscale.
Review :
I’d never encountered Vale before reading this book, but I’m much better informed now. Hogan’s writing, as always, is clear, informative, and most importantly, actionable. I now plan to implement Vale both at my organization and for my personal projects.— Steve Hill, Senior Developer, Resource Guru
I would recommend this book to technical writers or anyone in a documentation-heavy role who is looking to enhance their existing workflow, enforce consistent style, and improve the overall quality of their written content. It's a practical and effective guide.— Abhigna Nagaraja, Staff Software Engineer
