@findoctave/eslint-config-mdx

ESLint configuration for MDX files. This config is ESM only and only supports ESLint 9+ (flat file config).

[!NOTE] It is recommended to use this alongside @findoctave/eslint-config.

Installation

npm install -D @findoctave/eslint-config-mdx
pnpm add -D @findoctave/eslint-config-mdx

Usage

This package includes multiple exports to support different use cases. Only use one of these exports at a time.

Base MDX linting

import octaveMdxConfig from '@findoctave/eslint-config-mdx';

export default [
  ...octaveMdxConfig,
  // your other configs...
];

MDX code block linting

This export will also lint MDX code blocks. It includes the base MDX linting rules as well.

import { codeBlocks as octaveMdxCodeBlocksConfig } from '@findoctave/eslint-config-mdx';

export default [
  ...octaveMdxCodeBlocksConfig,
  // your other configs...
];

Features

• MDX-specific linting rules
• JSX support for MDX files
• Markdown and JavaScript linting

License

MIT