Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Two new rules; are there more on the way? #37

Open
chris-c-thomas opened this issue Feb 6, 2023 · 3 comments
Open

Two new rules; are there more on the way? #37

chris-c-thomas opened this issue Feb 6, 2023 · 3 comments

Comments

@chris-c-thomas
Copy link

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.

@khiga8
Copy link
Contributor

khiga8 commented 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 to markdownlint so 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 .json files.

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
Copy link
Author

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
Copy link

aepfli commented 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 :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants