[GH-ISSUE #163] .markdownlint format optional extension #1988

Closed
opened 2026-03-07 20:03:26 +03:00 by kerem · 3 comments
Owner

Originally created by @syntaqx on GitHub (Feb 3, 2019).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/163

It would be awesome if both .markdownlint.yaml and .markdownlint.yml were supported as file extensions. Because YAML recommends .yaml if both files exist, it's reasonable that this should be loaded and the other ignored.

The main reasons for supporting this additional extension are:

  1. Many other service tooling files specify an allowance for, preference for, or only allow for .theirtool.yml. (.travis.yml, docker-compose.yml, heroku.yml, .golangci.yml to name a few)
  2. There is some preference (albeit not convincingly) for using 3 letter file extensions on Windows platforms.

Long story short, my repository has a bunch of these configuration files for the various tools I implement, and .markdown.yaml is the only one using .yaml as an extension. It's triggering my punctilious organizational symmetry preferences, and I need your help.

<3

Originally created by @syntaqx on GitHub (Feb 3, 2019). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/163 It would be awesome if both `.markdownlint.yaml` and `.markdownlint.yml` were supported as file extensions. Because [YAML recommends](http://www.yaml.org/faq.html) `.yaml` if both files exist, it's reasonable that this should be loaded and the other ignored. The main reasons for supporting this additional extension are: 1. Many other service tooling files specify an allowance for, preference for, or only allow for `.theirtool.yml`. (`.travis.yml`, `docker-compose.yml`, `heroku.yml`, `.golangci.yml` to name a few) 2. There is some preference (albeit not convincingly) for using 3 letter file extensions on Windows platforms. Long story short, my repository has a bunch of these configuration files for the various tools I implement, and `.markdown.yaml` is the only one using `.yaml` as an extension. It's triggering my punctilious organizational symmetry preferences, and I need your help. <3
kerem 2026-03-07 20:03:26 +03:00
  • closed this issue
  • added the
    question
    label
Author
Owner

@DavidAnson commented on GitHub (Feb 3, 2019):

This appears to be a duplicate of https://github.com/DavidAnson/vscode-markdownlint/issues/60 which I expect to get to soon.

<!-- gh-comment-id:460032017 --> @DavidAnson commented on GitHub (Feb 3, 2019): This appears to be a duplicate of https://github.com/DavidAnson/vscode-markdownlint/issues/60 which I expect to get to soon.
Author
Owner

@syntaqx commented on GitHub (Feb 3, 2019):

My apologies for the duplicate! Excited that others also would like the functionality though :) Would you like me to close this out and use the other ticket for tracking?

<!-- gh-comment-id:460032221 --> @syntaqx commented on GitHub (Feb 3, 2019): My apologies for the duplicate! Excited that others also would like the functionality though :) Would you like me to close this out and use the other ticket for tracking?
Author
Owner

@DavidAnson commented on GitHub (Feb 3, 2019):

Yes, let’s!

<!-- gh-comment-id:460075374 --> @DavidAnson commented on GitHub (Feb 3, 2019): Yes, let’s!
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/markdownlint#1988
No description provided.