Add-onsVale Linter for Markdown and HTML Validation
Vale Linter for Markdown and HTML Validation
The Vale Linter for Markdown and HTML Validation addon runs Vale linter over the current edited file and presents the validation errors in the results area.
Although Vale supports multiple file formats, this plugin currently supports only Markdown (*.md files) and HTML files.
What's new in version 1.0.1
- Added support for the the latest Vale releases.
Setup
-
Download and unzip the proper Vale executable for your OS. On Linux and Mac, you need to give executable permission to the Vale executable. You can do this by opening a console in the Vale directory and running:
chmod u+x vale
- Go to Options -> Preferences..., go to the plugin's preferences page (Plugins / Oxygen Vale Validation) and specify the path to the previously downloaded Vale executable.
- In the same preferences page you can also specify a path to a Vale configuration file (.vale.ini). Vale auto detects this file by looking 6 levels up in the current file's ancestor directories, but you can also impose one.
Vale Styles
Vale uses collections of individual YAML files (or "rules") to enforce particular
writing constructs. These collections are referred to as styles and are
organized in a nested folder structure at a user-specified location. The
.vale.ini
file is
where you'll control the majority of Vale's behavior, including what files to lint
and how to lint them. Vale auto detects
.vale.ini, but you can also specify the path to .vale.ini from
the plugins preferences page (Options -> Preferences..., page Plugins /
Oxygen Vale Validation ).
Third-party styles
Vale has a growing selection of pre-made styles available for download from its style library.