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.
We use Gitbook for our documentation. Each time when editing, new markdownlint errors appear.
Examples:
Although I like having the same style on each text file (.java, .md, ...), I also agree that I cannot fight against Gitbook to have "proper" markdown generated.
Examples for "their" markdown:
I think, my energy is spend better at other places, so I disable checking that for our docs.
Nevertheless, I keep it intact for the files we create for ourselves, so that
CHANGELOG.md
described in a way that is understandable for the average user (if applicable)