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

Add new required(ish) "parser" parameter to markdownlint custom rule examples in Content Linter README.md. #33113

Merged
merged 2 commits into from
May 24, 2024

Conversation

DavidAnson
Copy link
Contributor

@DavidAnson DavidAnson commented May 22, 2024

Why:

parser is a new required (tho it's okay if it's not present for now) property on markdownlint 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).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

Copy link

welcome bot commented May 22, 2024

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label May 22, 2024
@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team and removed triage Do not begin working on this issue until triaged by the team labels May 22, 2024
@nguyenalex836
Copy link
Contributor

@DavidAnson Thanks so much for opening a PR! I'll get this triaged for review ✨

@nguyenalex836 nguyenalex836 added the waiting for review Issue/PR is waiting for a writer's review label May 22, 2024
@gracepark
Copy link
Contributor

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!

@gracepark gracepark self-assigned this May 24, 2024
@gracepark gracepark enabled auto-merge May 24, 2024 15:31
@gracepark gracepark added this pull request to the merge queue May 24, 2024
Merged via the queue into github:main with commit 1154e26 May 24, 2024
33 checks passed
Copy link
Contributor

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

@DavidAnson
Copy link
Contributor Author

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.

@gracepark
Copy link
Contributor

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants