madr icon indicating copy to clipboard operation
madr copied to clipboard

Misspelling of the .markdown-cli2.yaml file and possible issue with the markdown glob pattern

Open VerticalVeith opened this issue 6 months ago • 1 comments

According to the markdownlint documentation, the markdown CLI configuration is supposed to sit in a .markdownlint-cli2.yaml file. This repo has a makrdownlint-cli2.yml file at https://github.com/adr/madr/blob/develop/.makrdownlint-cli2.yml (note the swapped k and r and .yml as suppose to .yaml).

- .makrdownlint-cli2.yml
+ .markdownlint-cli2.yaml

Markdownlint lint does not appear to support the .yml extension.

Additionally, the glob parameter for *.md has a trailing , see: https://github.com/adr/madr/blob/d4b6455596433b40f23f6e388c51226175b9b75f/.github/workflows/lint.yaml#L20 This does not appear to be part of the docs and might cause only *.md, file to be linted in the root, e.g. test.md, and not files like README.md. Also see logs of the lint action in this run as long as it is not out of the retention period.

Maybe I am missing something and the lint pipeline appears to be functioning just fine, but I thought I'd write this issue to raise awareness.

VerticalVeith avatar Aug 12 '25 10:08 VerticalVeith

Someone wanting to learn about markdown-lint can take this issue.

It is non-breaking.

koppor avatar Aug 13 '25 16:08 koppor