Skip to content

Style Guide Rules for use with Vale Linter

Notifications You must be signed in to change notification settings

vkhoroz/fio-style

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Foundries.io Style Guide

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

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 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.

About

Style Guide Rules for use with Vale Linter

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published