[Docs] Add markdownlint #2852
Merged
[Docs] Add markdownlint #2852
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
ljharb
reviewed
Aug 8, 2023
ljharb
reviewed
Aug 8, 2023
|
hmm, it seems like the node 4 build is failing; does markdownlint-cli depend on something that uses aliases? if it's bringing in |
… kill the install process in npm < 6 See isaacs/jackspeak#4
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.
Add popular tool markdownlint-cli which runs markdownlint via a package.json script for documentation formatting consistency and best practices.
The majority of these changes were autofixed.
More info in this related PR:
There's a good markdownlint VSCode extension which highlights and autofixes these issues as well: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint
This will make it easier and safer to edit docs going forward.