-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add markdownlint for documentation formatting consistency #3367
Merged
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
bmish
commented
Aug 21, 2022
Codecov Report
@@ Coverage Diff @@
## master #3367 +/- ##
=======================================
Coverage 97.54% 97.54%
=======================================
Files 123 123
Lines 8873 8873
Branches 3244 3244
=======================================
Hits 8655 8655
Misses 218 218 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
ljharb
reviewed
Aug 21, 2022
bmish
force-pushed
the
markdownlint
branch
3 times, most recently
from
August 21, 2022 21:11
456fab3
to
04b4db1
Compare
ljharb
reviewed
Aug 21, 2022
ljharb
reviewed
Aug 21, 2022
bmish
force-pushed
the
markdownlint
branch
4 times, most recently
from
August 22, 2022 15:07
c53423d
to
889bb35
Compare
ljharb
approved these changes
Aug 22, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for bearing with me!
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 vast majority of these changes were autofixed.
Summary of the main changes:
There's a good markdownlint VSCode extension which highlights and autofixes these issues as well: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint