Skip to content

feat(markdownlin2) - implement markdownlint2 for linting markdown files #357

@abhisheksr01

Description

@abhisheksr01

Description

Implement markdownlint2 for linting and fixing markdown files in this project for consistent markdown. linting in this project.

Use Case

Currently, there is no markdown linting implemented in this repository thus making the markdown code untidy and inconsistent.
There is no markdown linting available in the CI as well.

Proposed Solution

I propose the following:

  • Implement markdownlint2 for lining markdown files
  • Add instructions for using markdownlint2 in this project
  • Add markdownlint2 in GHA CI for lining the files
  • Fix or Ignore markdown lint errors appropriately

Benefits

  • Consistent markdown linting in this project
  • Better readability and engagement with the documentation

Example:

After installation markdownlint2 can be used as below:

markdownlint-cli2 "**/*.md"

or

markdownlint-cli2 "**/*.md" --fix

Additional Information

Link to the markdownlist-clis2 documentation: https://github.com/DavidAnson/markdownlint-cli2

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions