Enforcing text style with Vale
Prose Police
Maintaining a consistent style can become challenging when multiple individuals contribute to a software project's documentation or a magazine. Vale checks your plain text files and even allows you to create custom style rules.
Vale [1] is an open source command-line tool used to enforce editorial style guidelines in texts. It doesn't work with word processors such as LibreOffice Writer. Instead, it's tailored for documents composed in plain-text markup languages such as Markdown [2], reStructuredText [3], AsciiDoc [4], or HTML. These markup languages are often used in documentation of open source projects, making Vale an ideal tool for enforcing a consistent style in software documentation. The list of Vale users [5] encompasses companies and projects such as Microsoft, Docker, Linode, Red Hat, GitLab, Grafana Labs, Neo4j, Angular, and Fedora.
Of course, Vale isn't restricted to documentation. As long as you write your texts in one of the supported markup languages, Vale can check them. Since I've always written my magazine articles in Markdown, I began to use Vale a few years ago to check them for common language errors, using some custom rules to cater for the preferences of different magazines. I like how Vale provides capabilities for my text files that I'm familiar with from code linters for programming languages.
Installing Vale
The Vale project publishes its source code [6], written in Go, on GitHub under the MIT license. The Vale releases [7] page offers downloadable precompiled binaries for Linux, macOS, and Windows. Some Linux distributions have packaged Vale and offer it through their repositories, but these are often older releases. There are also third-party packages available to install Vale from PyPI or from npm. Docker Hub also hosts Vale as a container image, jdkato/vale [8]. You can find instructions for all installation types [9] in Vale's documentation.
[...]
Buy this article as PDF
(incl. VAT)
Buy Linux Magazine
Subscribe to our Linux Newsletters
Find Linux and Open Source Jobs
Subscribe to our ADMIN Newsletters
Support Our Work
Linux Magazine content is made possible with support from readers like you. Please consider contributing when you’ve found an article to be beneficial.

News
-
There's a New Linux AI Assistant in Town
Newelle is a Linux AI assistant that can work with different LLMs and includes document parsing and profiles.
-
Linux Kernel 6.16 Released with Minor Fixes
The latest Linux kernel doesn't really include any big-ticket features, just a lot of lines of code.
-
EU Sovereign Tech Fund Gains Traction
OpenForum Europe recently released a report regarding a sovereign tech fund with backing from several significant entities.
-
FreeBSD Promises a Full Desktop Installer
FreeBSD has lacked an option to include a full desktop environment during installation.
-
Linux Hits an Important Milestone
If you pay attention to the news in the Linux-sphere, you've probably heard that the open source operating system recently crashed through a ceiling no one thought possible.
-
Plasma Bigscreen Returns
A developer discovered that the Plasma Bigscreen feature had been sitting untouched, so he decided to do something about it.
-
CachyOS Now Lets Users Choose Their Shell
Imagine getting the opportunity to select which shell you want during the installation of your favorite Linux distribution. That's now a thing.
-
Wayland 1.24 Released with Fixes and New Features
Wayland continues to move forward, while X11 slowly vanishes into the shadows, and the latest release includes plenty of improvements.
-
Bugs Found in sudo
Two critical flaws allow users to gain access to root privileges.
-
Fedora Continues 32-Bit Support
In a move that should come as a relief to some portions of the Linux community, Fedora will continue supporting 32-bit architecture.