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.
Use GitHub Action to run CI, all CI does is lint markdown files with
mdl
command, see https://github.com/markdownlint/markdownlint project.Currently, the default rules of
mdl
already found some issues in bunch of files:Most of the default rules are fine, except:
:dash
should be preferred, because-
only needs a single key stroke while*
requires shift:one
definitely makes life easier.I suggest we should discuess about the rules, once aligned I can add a config file for
mdl
and fix remaining lint issues in PR.