Skip to content

Commit ee109e5

Browse files
committed
Revert markdownlint-cli2 back to markdownlint for local testing
1 parent c83003f commit ee109e5

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -194,16 +194,11 @@ We have a GitHub Action that checks for formatting errors on Pull Requests. To f
194194
**Local Testing**
195195
For faster PR review, you may want to run linting locally. We recommend installing `markdownlint-cli2` or the VS Code extension.
196196

197-
```bash
198-
# Install
199-
npm install markdownlint-cli2 --global
200-
# Run on the specific file you are editing
201-
markdownlint-cli2 "docs/path/to/your/file.md"
202-
# Fix simple errors automatically
203-
markdownlint-cli2 --fix "docs/path/to/your/file.md"
197+
```console
198+
markdownlint -c .markdownlint.json -f docs/wiki-guide/
204199
```
205200

206-
The `--fix` resolves simple formatting issues, and alerts will be raised for more complicated linter style rules (e.g., referencing a link as `[here](URL)` will produce the line: `<filename>.md:191:2 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]`).
201+
The `-f` resolves simple formatting issues, and alerts will be raised for more complicated linter style rules (e.g., referencing a link as `[here](URL)` will produce the line: `<filename>.md:191:2 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]`).
207202

208203
### Content Review
209204

0 commit comments

Comments
 (0)