Skip to content

Docs: README.md starts the same as eslint-plugin-markdown #372

@JoshuaKGoldberg

Description

@JoshuaKGoldberg
Contributor

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.

A JS code snippet in a Markdown editor has red squiggly underlines. A tooltip explains the problem.

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:

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

Additional comments

No response

Activity

nzakas

nzakas commented on May 12, 2025

@nzakas
Member

Thanks for pointing this out. The plugin actually does two things:

  1. You can lint Markdown code directly
  2. You can lint code snippets in markdown using the processor

The image is showing case 2, which I think is fine. Maybe it just needs to spell out these two cases explicitly?

moved this from Needs Triage to Triaging in Triageon May 12, 2025
lumirlumir

lumirlumir commented on May 13, 2025

@lumirlumir
Member

Yes, currently @eslint/markdown does two things: it uses a processor and also a plugin.

It would be great to add more details to the README.md explaining both behaviors.

Marking this as accepted!

moved this from Triaging to Ready to Implement in Triageon May 13, 2025
moved this from Ready to Implement to Complete in Triageon May 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Type

No type

Projects

Status

Complete

Milestone

No milestone

Relationships

None yet

    Development

    Participants

    @nzakas@JoshuaKGoldberg@lumirlumir

    Issue actions

      Docs: README.md starts the same as eslint-plugin-markdown · Issue #372 · eslint/markdown