Added markdownlint2 for detecting Markdown formatting issues#3102
Draft
Added markdownlint2 for detecting Markdown formatting issues#3102
Conversation
|
❌ The last analysis has failed. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Target: v5, 4.6
Issues like in #3100 should be detected automatically by tools, we shouldn't stumble on it by mistake.
This PR adds a Markdown linter that can automatically detect issues like these.
Usage in GitLab:
https://docs.gitlab.com/development/documentation/testing/markdownlint/
Rules:
https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#rules
For now, I've only enabled the rules that:
For in the future we can consider more of them (but that would require more changes to the content, and I want to keep this PR small on purpose).