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.
Done so far:
markdownlint
doesn't know how to autocorrect w/--fix
flagTo do:
markdownlint --fix '**/*.md'
, review the hundreds of changes.markdownlint.yml
one at a time, runmarkdownlint '**/*.md'
, and either remediate the effected docs or dicide to keep the rulegit blame
. 99% sure this is possible.Notes:
The main markdown linters I found are:
I'm using the latter because it appears to have more active maintenance including, critically, on the ruleset. I'm using markdownlint-cli rather than markdownlint-cli2 because there seems to be better support of the former in existing github actions.
I don't have any plans to work on this further anytime soon, so if someone finds this work valuable please feel free to pick it up and run with it.