search

eslint / markdown

Lint JavaScript code blocks in Markdown documents
MIT License
406 stars 63 forks source link

Docs: README: wrong rule description, missing recommended list #273

Closed danielrentz closed 2 months ago

danielrentz commented 2 months ago

Docs page(s)

https://github.com/eslint/markdown/blob/main/README.md

What documentation issue do you want to solve?

  1. Rule table: "no-html" contains wrong description "Enforce fenced code blocks to specify a language."
  2. There is no information which rules are included in "recommended".

What do you think is the correct solution?

  1. Rule table: "no-html" description should be "Disallow HTML tags.".
  2. The rule table should contain a "Recommended" column.

Participation

Additional comments

No response

fasttime commented 2 months ago

Thanks! The wrong rule description looks like a copy-paste mistake, and I agree it would be good to indicate which rules are included in the recommended config. We could think of a way to update the docs automatically using rules metadata during the build like we do in ESLint. I believe this would make sense given that the recommended config is also autogenerated (in tools/build-rules.js). Would like @nzakas' perspective on this.

nzakas commented 2 months ago

Yeah, just a copy-paste error. Updating the README automatically would be nice! Feel free to put that together.

fasttime commented 2 months ago

I'll work on this.