Style guide linting¶

The starter pack includes a method to run the Vale documentation linter configured with the Vale rules for the current style guide.

Run the style guide linting¶

Check documentation with Vale:

make vale

Vale can run against individual files, directories, or globs. To set a specific target:

make vale TARGET=example.file
make vale TARGET=example-directory

Note

Running Vale against a directory will also run against subfolders.

You can use wildcards to run against all files matching a string, or an extension.

For example, to run against all .md files within a folder:

make vale TARGET=*.md

To match, for example, doc_1.md and doc_2.md:

make vale TARGET=doc*

To disable Vale linting within individual files, specific markup can be used.

For Markdown:

<!-- vale off -->

This text will be ignored by Vale.

<!-- vale on -->

For reST:

.. vale off

This text will be ignored by Vale.

.. vale on