diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-05 06:08:49 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-05 06:08:49 +0300 |
| commit | 79cbe31b18159ea394c6f6e3027c1dc69bdabb75 (patch) | |
| tree | 2f7290dd776762b18d0b4b95b81d380499f021ed /doc/development/documentation/index.md | |
| parent | e40710ab8a30f36d7c82d7d6497033291840eec9 (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation/index.md')
| -rw-r--r-- | doc/development/documentation/index.md | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/development/documentation/index.md b/doc/development/documentation/index.md index 2022beb69fa..68495178511 100644 --- a/doc/development/documentation/index.md +++ b/doc/development/documentation/index.md @@ -531,7 +531,14 @@ Vale supports creating [custom tests](https://errata-ai.github.io/vale/styles/), stored in the `doc/.linting/vale/styles/gitlab` directory, that extend any of several types of checks. -To view linting suggestions locally, you must install Vale on your own machine, and +To view linting suggestions locally, you must install Vale on your own machine, +and from GitLab's root directory (where `.vale.ini` is located), run: + +```shell +vale --glob='*.{md}' doc +``` + +You can also [configure the text editor of your choice](https://errata-ai.github.io/vale/#local-use-by-a-single-writer) to display the results. |