Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 1.31 KB

README.md

File metadata and controls

29 lines (19 loc) · 1.31 KB
Raw

Foundries.io Style Guide

This repository contains an implementation of the FoundriesFactory® style guide. Use this with the Vale(LICENSE) linter.

Installing from releases will also pull in the styles:

  • write-good; general good practices for writing in English
  • alex; checks for insensitive or inappropriate language

Overview

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 go into the 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 has integrations with common editors/IDEs.