Commit e5f8b338 authored by Marcel Amirault's avatar Marcel Amirault

Merge branch 'docs-vale-how-to' into 'master'

Mention how to run Vale locally

See merge request gitlab-org/gitlab!24255
parents ce4e30e8 74fbd118
...@@ -531,7 +531,14 @@ Vale supports creating [custom tests](https://errata-ai.github.io/vale/styles/), ...@@ -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 stored in the `doc/.linting/vale/styles/gitlab` directory, that extend any of
several types of checks. 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) [configure the text editor of your choice](https://errata-ai.github.io/vale/#local-use-by-a-single-writer)
to display the results. to display the results.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment