Skip to content

testthedocs/CockroachDB

Repository files navigation

CockroachDB

A Vale linter style that replicates the cockroachlabs.com/docs.

Build Status Vale version license

This repository contains a Vale-compatible implementation of the guidelines enforced by the cockroachlabs.com/docs style guide.

Getting Started

❗ Requires Vale >= 1.7.0. ❗

Download the latest release, copy the "CockroachDB" 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 = CockroachDB

See Usage for more information.