Markdown linter: Fix three annoying/buggy rules#8
Merged
Conversation
Remove rule MD024 from linter checks. This means that having multiple markdown headers with the same title will not be a problem anymore. This was annoying for documents like this (example taken from IronMan-Vault): ```md # Vault API ## Data Structures ### Account ### User ### Role ## Database ### Account ### User ### Role ``` Drawback: anchors generated by GitHub (to allow creating URLs pointing directly to a paragraph) will collide for headers with the same label.
|
LGTM. 👍 Though there's still the option of creating the anchors manually. |
The default behavior when rule MD029 isn't given arguments is pretty
weird: it only accepts list with `1.` prefixes, e.g.:
1. Do this.
1. Do that.
1. Done.
This patch changes the style to "ordered" so valid lists look like:
1. Do this.
2. Do that.
3. Done.
Rule MD007 (unordered list indentation) is very restrictive and
sometimes annoying. For instance, it detects such lists as invalid
because of the nested one indentation:
1. First, look at this list
* nested item 1
* nested item 2
2. Then, another ordered item
This patch disables this rule.
adrienverge
changed the title
Contributor
Author
|
I added two commits to the pull request, these are corrections for problems I detected when trying to lint markdown in the S3 project. Feel free to comment. |
|
Still LGTM. 👍 |
|
Okay for me, thanks for adding the explanatory comments, since the rules are not exactly clear about what they cover. |
Contributor
Author
|
Thanks @DavidPineauScality and @MichaelZapataScality! |
adrienverge
added a commit
that referenced
this pull request
Nov 2, 2015
Markdown linter: Fix three annoying/buggy rules
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.
Remove rule MD024 from linter checks. This means that having multiple
markdown headers with the same title will not be a problem anymore.
This was annoying for documents like this (example taken from
IronMan-Vault):
Drawback: anchors generated by GitHub (to allow creating URLs pointing
directly to a paragraph) will collide for headers with the same label.