Skip to content

A Vale linter style that replicates the 18F style guide

License

Notifications You must be signed in to change notification settings

testthedocs/18F

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

18F

A Vale linter style that replicates the 18F.

Not complete, and WIP, contributions welcome.😁

Build Status Vale version license

This repository contains a Vale-compatible implementation of the guidelines enforced by the 18F.

This project is in the worldwide public domain.

As a work of the United States government, this project is in the public domain within the United States.

Additionally, we waive copyright and related rights in the work worldwide through the CC0 1.0 Universal public domain dedication.

Getting Started

❗ Requires Vale >= 1.7.0. ❗

Download the latest release, copy the "18F" directory to your StylesPath, and include it in your configuration file:

# This goes in a file named either `.vale.ini` or `_vale.ini`.
StylesPath = path/to/some/directory
MinAlertLevel = warning # suggestion, warning or error

# Only Markdown and .txt files; change to whatever you're using.
[*.{md,txt}]
# List of styles to load.
BasedOnStyles = 18F

See Usage for more information.