Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
10187337
Commit
10187337
authored
Jun 01, 2020
by
Evan Read
Committed by
Marcel Amirault
Jun 01, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Improves information on linting docs in editors
parent
64dc299f
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
12 additions
and
5 deletions
+12
-5
doc/development/documentation/index.md
doc/development/documentation/index.md
+12
-5
No files found.
doc/development/documentation/index.md
View file @
10187337
...
@@ -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:
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment