Vale linter

Find out how to set up and use Vale linter.

This section provides step-by-step instructions how to install and use Vale linter.

In these tutorials I will share my experience in installing and using Vale linter. To find more about Vale, see Vale Documentation.

The developers use linters to run automatic checks for their code quality. To read more about linters, see What is a linter and why your team should use it?

Technical writers use the Vale linter to check if the text in their Markdown (HTML, AsciiDoc, etc.) files is in line with the style guides: Microsoft, Google, etc. The Vale configuration file includes the path to the style guides folder. Each style guide has its own rules in the form of regular expressions. When you run Vale, it searches for the patterns in your text and flags the errors and inconsistencies with the linked style guides. In addition, you can create a list of accepted words and a list of words that should be rejected. Vale flags a warning if you use the words from the rejected list.

How to install Vale on Windows

Use this instruction to install the Vale linter on Windows.

How to update Vale on Windows

Use this instruction to update the Vale linter version on Windows.

How to configure Vale for GitHub repository

Use this instruction to configure Vale for a GitHub repository. You learn how to add the files required for Vale to run the checks on your Markdown files.

Style guides, linters, and Vale: Why do tech writers need this?

Read about the style guides the tech writers use in their work and why it’s important. Also, read about the linter for tech writers. Configure the Vale linter for checking how your texts comply with the recommendations in the style guides of Google and Microsoft. As a bonus, learn how to create your own style guide for Vale.

Last modified March 9, 2023: first commit (98b8333)