This repository houses the documentation and website source for Vale. We write our documentation in Markdown and use MkDocs to build it.
You'll need Python 2.7 installed. Then, just enter the following commands:
$ git clone https://github.com/ValeLint/docs.git
$ cd docs
$ pip install -r requirements.txt
$ mkdocs serve
We follow 18F's content guidelines with the following additions and changes:
- Use standard American English spelling.
- Capitalize "Vale" unless specifically referring to the binary (in which case it should be in a code span—i.e.,
vale
). - Use correct tech terminology: JavaScript, HTML, etc.
- Use title case for headings.
We also use awesome_bot
to check our links and markdown-spellcheck
to check our spelling.
Have a style to share? Great—we'd love to include it in our list! Just follow this step-by-step process:
-
Open the
data/styles.yml
file on GitHub. -
Press the Pencil Icon in the upper Right Corner of the Code Preview.
-
Add your style to the correct category, following this structure:
- title: {...} summary: {...} url: {source link} download: {.zip download link}
-
Save your commit and submit a pull request.