https://github.com/azz/eslint-plugin-mdx

ESLint Plugin for MDX
https://github.com/azz/eslint-plugin-mdx

eslint mdx

Last synced: 5 months ago
JSON representation

ESLint Plugin for MDX

• Host: GitHub
• URL: https://github.com/azz/eslint-plugin-mdx
• Owner: azz
• License: mit
• Archived: true
• Created: 2018-09-28T03:22:49.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-08-14T13:39:45.000Z (over 5 years ago)
• Last Synced: 2024-08-03T21:02:09.635Z (9 months ago)
• Topics: eslint, mdx
• Language: JavaScript
• Homepage:
• Size: 69.3 KB
• Stars: 19
• Watchers: 5
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# `eslint-plugin-mdx`

> **This repository is no longer maintained, and the `eslint-plugin-mdx` name has been transferred to [eslint-mdx](https://github.com/rx-ts/eslint-mdx).**

---

[![Travis](https://img.shields.io/travis/azz/eslint-plugin-mdx.svg?style=flat-square)](https://travis-ci.org/azz/eslint-plugin-mdx)

[![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

[![npm](https://img.shields.io/npm/v/eslint-plugin-mdx.svg?style=flat-square)](https://npmjs.org/eslint-plugin-mdx)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)

[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)

> [ESLint](https://eslint.org/) parser for [MDX](https://github.com/mdx-js/mdx)

## Install

With `yarn`:

```shellsession

yarn add eslint-plugin-mdx

```

With `npm`:

```shellsession

npm install --save eslint-plugin-mdx

```

## Usage

1. In your ESLint config file, add:

   ```json

   {

     "extends": ["plugin:mdx/recommended"]

   }

   ```

2. Make sure ESLint knows to run on `.mdx` files:

   ```shellsession

   eslint --ext js,mdx .

   ```