Skip to content
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
@dshevtsov

Description

@dshevtsov

Bug report

Description

The Markdown linter reports about 5224 issues when rule 'MD004' is enabled.

Instructions

  1. Checkout the MD004-integration branch.
  2. In the _checks/styles/style-rules-prod file, change exclude_rule 'MD004' to rule 'MD004'.
  3. In your terminal, run rake test:md.
  4. Review the list of errors.
  5. 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).
  6. Fix errors.

Test your updates

  1. Follow "Instructions" locally to get list of errors to fix.
  2. 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

EditorialTypo and grammar fixes or minor rewrites to correct inaccuraciesInternal DevDifferentiates work between community and Magento staff

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions