Markdown lint

[literat]

Markdown

We should be able lint and format our readmes and other markdown documentation.

Remark CLI is great candidate.

@adamkudrna If linting is all we need, I have quite a good experience with https://github.com/DavidAnson/markdownlint-cli2 (compatible with MDX, to certain extent).

See: https://github.com/strvcom/code-quality-tools/tree/master/packages/remark-config

[literat]

Remark CLI

Pros:

• Wider support (more stars)
• More used (8.8k)
• Under instant maintenance (lastly updated within days)
• Ready to copy package (https://github.com/strvcom/code-quality-tools/tree/master/packages/remark-config)

Neutral:

• More rules (https://github.com/remarkjs/remark-lint#rules)
• Existing presets (https://github.com/remarkjs/remark-lint#presets)

Cons:

• Name of lint config (remarkrc) - something like "markdownlintrc" will be better

[literat]

Markdownlint CLI

Pros:

• Better config name (markdownlint)

Neutral:

• nfewrules (https://github.com/DavidAnson/markdownlint/blob/main/README.md#rules--aliases)

Cons:

• still not stable (0.x.x)
• not so often updated (last months ago)
• not so used (338 people)

[literat]

🔝 @adamkudrna Is there anything else I am missing?