Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
abhisheksr01 opened this issue Dec 27, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@abhisheksr01
Copy link
Owner

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

@abhisheksr01 abhisheksr01 added the enhancement New feature or request label Dec 27, 2024
@abhisheksr01 abhisheksr01 changed the title feat(markdownlin2) - implement markdownlint2 for linting and fixing markdown files in this project feat(markdownlin2) - implement markdownlint2 for linting markdown files Dec 27, 2024
@abhisheksr01 abhisheksr01 added the documentation Improvements or additions to documentation label Dec 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant