fix: incorrect docs due to prettier + mdx v2+ incompatible (#499)

mdx-js · Dec 24, 2023 · 97ade8f · 97ade8f
1 parent f3dea74
commit 97ade8f
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 3 deletions.
diff --git a/.changeset/strange-balloons-turn.md 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
@@ -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
@@ -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
@@ -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>