This repository was archived by the owner on Nov 19, 2024. It is now read-only.
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
Markdown linting: Inconsistent unordered list style (MD004 ) #5241
Closed
Description
Bug report
Description
The Markdown linter reports about 5224 issues when rule 'MD004' is enabled.
Instructions
- Checkout the
MD004-integration
branch. - In the
_checks/styles/style-rules-prod
file, changeexclude_rule 'MD004'
torule 'MD004'
. - In your terminal, run
rake test:md
. - Review the list of errors.
- Add a comment to this issue claiming a single directory that you want to work on (should include both v2.2 and v2.3 directories when applicable).
- Fix errors.
Test your updates
- Follow "Instructions" locally to get list of errors to fix.
- Preview the HTML locally to ensure your changes did not break formatting in the resulting HTML (run
rake:preview
). For more information, refer to the README.
Note-->Do NOT use special keywords in your commit message.
Expected result
All the reported issues are fixed.
The rake test:md
command returns No issues found
.
Additional information
-
Scope: It makes sense to fix the following issues at the same time as MD004:
- MD005: List indentation
- MD006: Start bulleted lists at the beginning of a line
- MD007: List indentation
- MD030: Spaces after list markers
-
See the Markdown linting issues wiki page for detailed guidelines.
Activity