Lint Markdown using mdl
to enforce correct presentation
#51
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.
Currently there are some Markdown format issues in CA/B Forum documents like https://github.com/cabforum/servercert/blob/main/docs/BR.md.
For example the following Markdown excerpt from the TLS BRs:
Looks like this when converted into PDF:
Where you can see that lists are not rendered correctly.
Now, with the following corrected Markdown (see the extra blank lines around lists):
It would look like this:
This PR looks to enforce this correct Markdown style by introducing the usage of https://github.com/markdownlint/markdownlint/ during the workflow run.
Other Markdown linting rules (see https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md) could be enforced in the future or they could be passed as parameters to the Action.