docs: fix md style #172
Merged
docs: fix md style #172
Conversation
This file contains 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
marquiz
force-pushed
the
devel/docs-mdlint
branch
2 times, most recently
from
b88be83 to
314911a
Compare
|
@marquiz I think this could be a good idea. What would be the best way to hook this in, as this is not a github workflow ? Should we run it as part of the containerized doc build ? That would automatically buy us a local check for free. |
Okay, actually there is a github action for it... |
That or then just have a shell script action |
Fix the following issues raised by markdownlint: - https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md004---unordered-list-style - https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md005---inconsistent-indentation-for-list-items-at-the-same-level - https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md006---consider-starting-bulleted-lists-at-the-beginning-of-the-line - https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md009---trailing-spaces - https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md010---hard-tabs - https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md012---multiple-consecutive-blank-lines - https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md013---line-length - https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md031---fenced-code-blocks-should-be-surrounded-by-blank-lines - https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md032---lists-should-be-surrounded-by-blank-lines - https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md040---fenced-code-blocks-should-have-a-language-specified Signed-off-by: Markus Lehtonen <[email protected]>
marquiz
force-pushed
the
devel/docs-mdlint
branch
from
314911a to
7712e53
Compare
|
Rebased, plus two small whitespaces fixes. Ready for review |
fmuyassarov
approved these changes
Oct 24, 2023
klihub
approved these changes
Oct 24, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fix the following issues raised by markdownlint:
Inspired by #169. If you like this idea we could enable markdownlint in the CI.