Show HN: Lint Your Markdown with ESLint

Now even your notes can get roasted before the internet does

TLDR: A new tool lets people clean up Markdown files like notes and project pages using the same checker many already use for code. Fans say it saves messy docs; critics joke tech has officially become obsessed with correcting spaces, lists, and everyone’s vibe.

A new Show HN post is pitching a simple idea: use ESLint, a popular code checker, to clean up Markdown, the plain-text format people use for notes, readme files, and docs. On paper, it’s tidy, practical, and almost aggressively wholesome. The creator even opens with the classic open-source love language: please star the project on GitHub. But the real action, as always, is in the crowd reaction, where people instantly turned a humble documentation tool into a mini culture war about how much policing is too much policing.

The strongest opinion? A split between “finally, my messy docs can stop embarrassing me” and “we are absolutely over-linting society”. Supporters loved the idea of catching broken formatting and keeping team docs neat, especially since the plugin is meant to work alongside ESLint’s built-in Markdown support rather than replace it. Critics, meanwhile, rolled their eyes at yet another tool for telling grown adults where to put spaces and punctuation, joking that soon we’ll need a linter for grocery lists and breakup texts. That spawned the best humor: comments riffing on “my README has a stricter upbringing than I did” energy, plus the usual programmer self-dragging about spending more time formatting notes than writing them. In other words: a small utility dropped, and the community immediately made it about control, chaos, and whether neatness is a virtue or a personality disorder.

Key Points

  • The article introduces eslint-markdown as a package for linting Markdown with ESLint.
  • The package provides additional rules designed for use with @eslint/markdown.
  • The article states that eslint-markdown does not duplicate ESLint’s built-in Markdown rules.
  • It recommends using eslint-markdown together with ESLint’s built-in Markdown support.
  • The project documentation includes installation, configuration, migration, rules, compatibility, security, and licensing information, and the package uses the MIT license.

Hottest takes

"we are linting markdown now" — dang
"a linter for my linter docs" — tateisuk
"soon someone will lint my shopping list" — throwaway815
Made with <3 by @siedrix and @shesho from CDMX. Powered by Forge&Hive.