Repository navigation
Two new rules; are there more on the way? #37
Description
Opening as a ticket since discussions are not enabled for this repo.
The only two rules this adds is GH001 No default alt text & GH002 No generic link text right? While all the rules from markdownlint are inherited?
Will this get more opinionated? I usually like to stick to @github's way of doing things on the platform. I know I can add my own of course.
Activity
khiga8 commentedon Feb 6, 2023
Hey @chris-c-thomas. So far we only have two custom rules though we certainly may add more if we notice a gap in the rulesets provided by
markdownlint. However, we'll likely try to upstream these rules tomarkdownlintso the greater community can benefit from it (related: DavidAnson/markdownlint#681).We use the markdownlint defaults as a baseline and have some opinions configured in the
.jsonfiles.For now, one of the main motivation behind this repo is enforcing accessibility standards within GitHub's open-source and internal markdown projects. We're still developing some opinions around that and can't decisively say "how opinionated" we'll be yet relative to the defaults. Apologies for the somewhat vague answer.
chris-c-thomas commentedon Feb 10, 2023
Thank you for the info! I often like to see how organizations, like GitHub, do things and implement similar practices when applicable. Sometimes it's definitely hard to decide what the opinions should be, hah!
aepfli commentedon Mar 29, 2023
I am unsure if I am hijacking this issue now. If I do, I am sorry. but I wanted to ask if https://github.com/aepfli/markdownlint-rule-github-admonition would be a rule I should integrate into this repository - as it covers GitHub-style admonitions. I would be happy to help integrate this :)