Add markdownlint
#1597
Merged
Add markdownlint
#1597
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
readme.md
Outdated
| - [Adam Babcock](https://github.com/MrHen) | ||
| - [futpib](https://github.com/futpib) | ||
| - [Fisker Cheung](https://github.com/fisker) | ||
| * [Sindre Sorhus](https://github.com/sindresorhus) |
There was a problem hiding this comment.
Updated this file to use dash - lists.
|
Does the linter not enforce which symbol to use for list items? |
Updated to require dash lists instead of just consistent which is the default. https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md004---unordered-list-style |
sindresorhus
approved these changes
Nov 11, 2021
fisker
approved these changes
Nov 11, 2021
XhmikosR
reviewed
Nov 17, 2021
| @@ -14,7 +14,7 @@ | |||
| "node": ">=12" | |||
| }, | |||
| "scripts": { | |||
| "test": "xo && nyc ava", | |||
| "test": "xo && nyc ava && markdownlint '**/*.md'", | |||
There was a problem hiding this comment.
FYI this doesn't work with Windows native CMD; double quotes work.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A few examples of what was fixed (most autofixed):
https://github.com/igorshubovych/markdownlint-cli
There's a good markdownlint VSCode extension which highlights and autofixes these issues as well: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint