docs: apply markdownlint #195
Merged
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
Pangssu
reviewed
Sep 12, 2023
| @@ -1,3 +1,4 @@ | |||
| <!-- markdownlint-disable MD053 --> | |||
There was a problem hiding this comment.
Why is MD053 disabled in this file?
There was a problem hiding this comment.
MD053 is a rule that Link and image reference definitions should be needed.
Without it, we need to remove all unused definitions such as [storage-root]: glossary.md#storage-root in this glossary file. But I think it is kind of convention to add the definition of all glossaries to use in future. So I suppressed this rule only for this glossary file.
Pangssu
approved these changes
Sep 13, 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.
Description
Since we have markdown linting rule (see here), I recommend to edit markdown files in VS Code and use this extension to apply markdownlint. With it, you can check if a line should be formatted or not, and also set the default formatter to it and auto-fix on save.