Markdown
An ESLint plugin to lint JavaScript, JSX, TypeScript, and other code blocks within Markdown documents.
What is Markdown?
@eslint/markdown (ESLint Markdown Language Plugin) is an official ESLint plugin that extends ESLint to parse and lint Markdown files. It lints the Markdown structure itself for issues like invalid headings and missing alt text, and also extracts and lints JavaScript, JSX, TypeScript, and other code blocks embedded within the Markdown. It ensures code quality and consistency in documentation, READMEs, and any Markdown content containing executable snippets.
Developers and technical writers who maintain documentation, READMEs, or code repositories with significant Markdown content that includes embedded code examples. It is particularly useful for teams enforcing consistent documentation standards alongside their code quality rules.
Developers choose this plugin because it is the official, first-party ESLint solution for Markdown, ensuring deep integration and reliability. It uniquely combines structural Markdown linting with the ability to apply the full power of ESLint to code blocks within documentation, treating documentation as a first-class citizen in the development workflow.
Overview
Lint JavaScript code blocks in Markdown documents
Use Cases
Best For
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
