From 97ade8f39bad40709bbf25ac5ec9750168281f8d Mon Sep 17 00:00:00 2001
From: JounQin <admin@1stg.me>
Date: Sun, 24 Dec 2023 17:15:36 +0800
Subject: [PATCH] fix: incorrect docs due to prettier + mdx v2+ incompatible
 (#499)

---
 .changeset/strange-balloons-turn.md  | 6 ++++++
 README.md                            | 6 +++++-
 packages/eslint-mdx/README.md        | 6 +++++-
 packages/eslint-plugin-mdx/README.md | 6 +++++-
 4 files changed, 21 insertions(+), 3 deletions(-)
 create mode 100644 .changeset/strange-balloons-turn.md

diff --git a/.changeset/strange-balloons-turn.md b/.changeset/strange-balloons-turn.md
new file mode 100644
index 00000000..4da185e0
--- /dev/null
+++ b/.changeset/strange-balloons-turn.md
@@ -0,0 +1,6 @@
+---
+"eslint-mdx": patch
+"eslint-plugin-mdx": patch
+---
+
+fix: incorrect docs due to prettier + mdx v2+ incompatible
diff --git a/README.md b/README.md
index 49b48b02..4e688780 100644
--- a/README.md
+++ b/README.md
@@ -163,8 +163,12 @@ See also <https://github.com/syntax-tree/mdast#code>
 
 A new `MDXHeading` estree node type is exported from `eslint-mdx` which represents markdown heading in `mdx` like the following:
 
+<!-- mdx v2+ incompatible -->
+<!-- prettier-ignore -->
 ```mdx
-<div># Here's a text gradient short code!</div>
+<div>
+# Here's a text gradient short code!
+</div>
 ```
 
 See also <https://github.com/syntax-tree/mdast#heading>
diff --git a/packages/eslint-mdx/README.md b/packages/eslint-mdx/README.md
index 49b48b02..4e688780 100644
--- a/packages/eslint-mdx/README.md
+++ b/packages/eslint-mdx/README.md
@@ -163,8 +163,12 @@ See also <https://github.com/syntax-tree/mdast#code>
 
 A new `MDXHeading` estree node type is exported from `eslint-mdx` which represents markdown heading in `mdx` like the following:
 
+<!-- mdx v2+ incompatible -->
+<!-- prettier-ignore -->
 ```mdx
-<div># Here's a text gradient short code!</div>
+<div>
+# Here's a text gradient short code!
+</div>
 ```
 
 See also <https://github.com/syntax-tree/mdast#heading>
diff --git a/packages/eslint-plugin-mdx/README.md b/packages/eslint-plugin-mdx/README.md
index 49b48b02..4e688780 100644
--- a/packages/eslint-plugin-mdx/README.md
+++ b/packages/eslint-plugin-mdx/README.md
@@ -163,8 +163,12 @@ See also <https://github.com/syntax-tree/mdast#code>
 
 A new `MDXHeading` estree node type is exported from `eslint-mdx` which represents markdown heading in `mdx` like the following:
 
+<!-- mdx v2+ incompatible -->
+<!-- prettier-ignore -->
 ```mdx
-<div># Here's a text gradient short code!</div>
+<div>
+# Here's a text gradient short code!
+</div>
 ```
 
 See also <https://github.com/syntax-tree/mdast#heading>