Skip to content

Latest commit

 

History

History
 
 

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Vale Docs

This repository houses the documentation for Vale, which is a static site built using a combination of Markdown, Markdata, and MkDocs.

Running Locally

You'll need Python 3.7.0+ and Pipenv. Then, just enter the following commands:

$ git clone https://github.com/errata-ai/vale.git
$ cd vale/docs
$ pipenv install
$ pipenv shell
$ mkdocs serve

Linting

We follow 18F's content guidelines with the following additions and changes:

  • Use standard American English spelling (e.g., "ize" instead of "ise").
  • Capitalize "Vale" unless specifically referring to the binary (in which case it should be in a code span—i.e., vale).
  • Use title case for headings.

We also use awesome_bot to check our links.