Adds pre-commit hook for markdownlint-cli2 and lints existing code base #195
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
Configuration files for [pre-commit](https://pre-commit.com) hook for [markdownlint-cli2](https://github.com/DavidAnson/markdownlint/).
Automated fixing of issues identified by [markdownlint-cli2](https://github.com/DavidAnson/markdownlint/).
Adding language to code block starts.
Disabled this check for two `!!!Note` sections which are not code blocks but the lines to include need to be indented.
Disabled this check in two files.
Disabled check to leave links to sections that are yet to be written.
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.
Closes #194
Adds pre-commit hook markdownlint-cli2 and addresses issues found.
Many were automatically corrected but some required addressing manually. Each linting error that required manually addressing is an individual commit, in a few instances the checks have been disabled and may be addressed subsequently as part of #191.
The
.pre-commit-config.yamlincludes configuration to run pre-commit.ci but this won't work/run until pre-commit.ci has been authorised to access/work with the repository so someone with that level of access will have to set that up.