CI: Lint all Markdown files in the project #14937
Merged
+77
−73
Conversation
This file contains hidden or 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
Adds globs and ignore rules.
This allows as to lint Markdown files locally by running as simple as:
$ markdownlint-cli2
or automatically fix issues with
$ markdownlint-cli2 --fix
It also fixes a bug when changes in `README.md` would not trigger this action on pushes and pull requests. Removes glob config and delegates to .markdownlint-cli2.jsonc
josevalim
reviewed
Nov 21, 2025
Member
|
💚 💙 💜 💛 ❤️ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Format all Markdown files according to Markdownlint rules
Replace
.markdownlint.jsoncwith.markdownlint-cli2.jsoncAdds globs and ignore rules.
This allows us to lint Markdown files locally by running as simple as:
or automatically fix issues with
It also fixes a bug when changes in
README.mdwould not trigger thisaction on pushes and pull requests.
Removes glob config and delegates to
.markdownlint-cli2.jsonc