-
Notifications
You must be signed in to change notification settings - Fork 60.3k
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
Add new required(ish) "parser" parameter to markdownlint custom rule examples in Content Linter README.md. #33113
Conversation
…examples in Content Linter README.md.
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
@DavidAnson Thanks so much for opening a PR! I'll get this triaged for review ✨ |
Hi @DavidAnson thanks for reaching out and for the contribution! I did notice it recently when I was looking at updating one of our custom rules. I'll make sure to update them all and get this added. Thanks again! |
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
FYI @gracepark if you are a rule maintainer, this new property does nothing at the moment, but I intend to use it soon to avoid loading the markdown-it parser once I have migrated all the core rules to micromark. Of course, if there are rules that need markdown-it tokens, it will be used and the tokens will still be available. From what I saw, GitHub rules take advantage of it, so there may not be a performance benefit for you folks. micromark is not yet available for public use, but that is also planned. Finally, note that if a rule doesn't use tokens at all, it can declare that. |
@DavidAnson - yes I'm apart of the team that maintains the rules. I'll let the others know as well. Thanks for the heads up. |
Why:
parser
is a new required (tho it's okay if it's not present for now) property onmarkdownlint
custom rules. This PR adds it to the two relevant examples.Closes:
N/A
What's being changed (if available, include any code snippets, screenshots, or gifs):
README
Check off the following:
I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).
data
directory.For content changes, I have completed the self-review checklist.