Markdown Linting

[VijaySharma815]

Prerequisites

• I checked the documentation and made sure this feature does not already exist.
• I checked the existing issues to make sure this feature has not already been requested.
• I have read the code of conduct before creating this issue.

Problem

Standards and consistency of Markdown files

Feature / Solution

Rules to enforce standards and consistency for Markdown files.

• Command to check the markdown files
• Auto fixes

---

Please see this:

• mdformat support added #279
• Md linting fixes #280
• Markdown Linting Github Action #250

Alternatives

No response

Additional Context

No response

[VijaySharma815]

We tried two packages:

mdformat: This tool seems to make several mistakes including not recognising the admonitions by mkdocs and some strange line breaking in History.md. Due to its automatic nature, markdown file lining needs to be 100% correct without needing manual changes which do not seem to be the case for this too.

Therefore, unless through configurations we can get it working without any errors.

makrdownlint: This tool requires the introduction of a heavy dependency, either npm and associated JS dependencies, or docker.