Commit 10187337 authored by Evan Read's avatar Evan Read Committed by Marcel Amirault

Improves information on linting docs in editors

parent 64dc299f
...@@ -533,7 +533,9 @@ If you wish to use a different configuration file, use the `-c` flag: ...@@ -533,7 +533,9 @@ If you wish to use a different configuration file, use the `-c` flag:
markdownlint -c <config-file-name> 'doc/**/*.md' markdownlint -c <config-file-name> 'doc/**/*.md'
``` ```
markdownlint can also be run from within text editors using [plugins/extensions](https://github.com/DavidAnson/markdownlint#related), ##### Run markdownlint in an editor
markdownlint can also be run as a linter within text editors using [plugins/extensions](https://github.com/DavidAnson/markdownlint#related),
such as: such as:
- [Sublime Text](https://packagecontrol.io/packages/SublimeLinter-contrib-markdownlint) - [Sublime Text](https://packagecontrol.io/packages/SublimeLinter-contrib-markdownlint)
...@@ -581,12 +583,17 @@ and from GitLab's root directory (where `.vale.ini` is located), run: ...@@ -581,12 +583,17 @@ and from GitLab's root directory (where `.vale.ini` is located), run:
vale --glob='*.{md}' doc 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.
Vale's error-level test results [are displayed](#testing) in CI pipelines. Vale's error-level test results [are displayed](#testing) in CI pipelines.
##### Run Vale in an editor
You can run Vale as a linter within your text editor of choice, with:
- The Sublime Text [`SublimeLinter-contrib-vale` plugin](https://packagecontrol.io/packages/SublimeLinter-contrib-vale)
- The Visual Studio Code [`testthedocs.vale` extension](https://marketplace.visualstudio.com/items?itemName=testthedocs.vale)
We don't use [Vale Server](https://errata-ai.github.io/vale/#using-vale-with-a-text-editor-or-another-third-party-application).
##### Disable a Vale test ##### Disable a Vale test
You can disable a specific Vale linting rule or all Vale linting rules for any portion of a document: You can disable a specific Vale linting rule or all Vale linting rules for any portion of a document:
......
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