@sheplu/eslint-config-markdown

A lightweight, opinionated ESLint configuration optimized for Markdown files. This package helps you keep your Markdown clean, consistent, and free of common mistakes - especially when embedding code blocks or documenting APIs.

Features

• Preconfigured ESLint rules for Markdown
• Zero-config: works out-of-the-box
• Supports ESLint v9 and Flat Config

Installation

npm install --save-dev @eslint/markdown
npm install --save-dev @sheplu/eslint-config-markdown

Usage

import { markdownRules } from "@sheplu/eslint-config-markdown";

export default defineConfig([
  {
    'extends': [ markdownRules ],
    'files': [ '**/*.md' ],
    'language': 'markdown/gfm',
    'plugins': { markdown },
  },
]);

You can also import directly the configuration and only expend the markdown plugin

import markdown from '@eslint/markdown';
import { defaultMarkdownConfig } from "@sheplu/eslint-config-markdown";

export default defineConfig([
    {
        ...defaultMarkdownConfig,
        'plugins': { markdown },
    }
]);

This should be the equivalent of

export default defineConfig([
    {
        'files': ['**/*.md'],
        'plugins': { markdown },
        'language': 'markdown/gfm',
        'extends': [markdownRules],
        'languageOptions': {
            frontmatter: 'yaml',
        },
    }
]);