ESLint Markdown – lint Markdown with ESLint

ESLint Markdown is the official Markdown language plugin for ESLint. It lets ESLint parse and lint Markdown documents using CommonMark or GitHub Flavored Markdown, bringing Markdown checks into the same configuration used for other project files.

Its rules cover areas such as heading structure, duplicate definitions, empty links and images, label references, link fragments, image alternative text and fenced code blocks. A processor can also extract fenced code blocks so their contents can be linted separately by ESLint.

The plugin also supports YAML, TOML and JSON front matter together with optional math syntax.

This is free and open source software.

Key Features

  • Provides native Markdown linting through ESLint’s language plugin architecture.
  • Supports both CommonMark and GitHub Flavored Markdown.
  • Checks headings, links, references, images, definitions, fenced code blocks and other Markdown structures.
  • Can extract fenced code blocks so their contents are checked with the appropriate ESLint rules.
  • Supports YAML, TOML and JSON front matter together with optional math parsing.
  • Allows individual Markdown rules to be disabled inline with ESLint comments.

Website: github.com/eslint/markdown
Support:
Developer: ESLint
License: MIT License

ESLint Markdown is written in JavaScript. Learn JavaScript with our recommended free books and free tutorials.


Related Software

Markdown Linters
markdownlintStatic analysis tool for Node.js
textlintPluggable linting tool for text and markdown
rumdlModern Markdown linter and formatter
MegaLinterAnalyzes the consistency of your code
remark-lintCheck Markdown code style
markdownlint-rubyTool to check markdown files and flag style issues
PyMarkdownMarkdown linter
MadoCheck Markdown documents for style and formatting issues,
gomarklintKeep documentation quality under control

Read our verdict in the software roundup.


Best Free and Open Source Software Explore our carefully curated directory of recommended free and open source software, covering every major software category.

The directory forms part of our extensive collection of articles for Linux enthusiasts. It includes hundreds of detailed reviews, together with free and open source alternatives to proprietary software from companies such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk.

LinuxLinks also covers interesting projects worth exploring, Linux-compatible hardware, free programming books and tutorials, and much more.

Know a useful free and open source Linux application that we haven’t covered? Tell us about it using our submission form.
Subscribe

Please read our Comment Policy before commenting.

Notify of
guest
0 Comments
Oldest
Newest Most Voted