docs

Vale Docs

This repository houses the documentation for Vale. We write our documentation in Markdown and use MkDocs to build it.

Running Locally

You'll need Python 2.7+ installed. Then, just enter the following commands:

$ git clone https://github.com/errata-ai/vale.git
$ cd docs
$ pip install -r requirements.txt
$ 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.