-
Notifications
You must be signed in to change notification settings - Fork 80
Closed
Labels
Description
Docs page(s)
The README.md for @eslint/markdown, as seen on https://www.npmjs.com/package/@eslint/markdown
What documentation issue do you want to solve?
https://www.npmjs.com/package/@eslint/markdown and https://www.npmjs.com/package/eslint-plugin-markdown both have after their badges:
Lint JS, JSX, TypeScript, and more inside Markdown.
This is incorrect for @eslint/markdown, right? From https://eslint.org/blog/2024/10/eslint-json-markdown-support/#markdown-linting-with-%40eslint%2Fmarkdown, @eslint/markdown is actually about linting the Markdown itself, right?
What do you think is the correct solution?
Switching the description to what's in the package.json:
Line 4 in 552915c
| "description": "The official ESLint language plugin for Markdown", |
...and either removing the image (to align with @eslint/json) or updating it.
Participation
- I am willing to submit a pull request for this change.To pick up a draggable item, press the space bar. While dragging, use the arrow keys to move the item. Press space again to drop the item in its new position, or press escape to cancel.
Additional comments
No response
Metadata
Metadata
Assignees
Labels
Type
Projects
Status
Complete
Milestone
Relationships
Development
Select code repository

Activity
nzakas commentedon May 12, 2025
Thanks for pointing this out. The plugin actually does two things:
The image is showing case 2, which I think is fine. Maybe it just needs to spell out these two cases explicitly?
lumirlumir commentedon May 13, 2025
Yes, currently
@eslint/markdowndoes two things: it uses aprocessorand also aplugin.It would be great to add more details to the
README.mdexplaining both behaviors.Marking this as accepted!