This repository contains an implementation of the Foundries.io style guide. It is compatible with the Vale(LICENSE) linter.
Installing from releases will also pull in additional style guides:
- write-good; general good practices for writing in English
- alex; checks for insensitive or inappropriate language
Vale is a linter for text; it checks a document for following a style.
In (and out) of Vale, a style is a set of rules, such as our Style Guide.
We can define these rules in a YAML file for Vale to use,
Rules go into a folder placed within the directory pointed to by StylesPath:
Styles/Fio-docs/<rule_name>.yml
StylePath, styles to use, and other options are set in a configuration file.
This can be _vale.ini or .vale.ini, and Vale will look first in the current
directory, and then in the users home directory.
Vale can be integrated with most editors.