chore: address review issue

mdx-js · Dec 16, 2023 · 22184ba · 22184ba
1 parent a3a86d8
commit 22184ba
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -149,28 +149,22 @@ A new `MDXCode` estree node type is exported from `eslint-mdx` which represents
 
 ````mdx
 <div>
-
-```js
-export function foo() {
-  return 'bar'
-}
-```
-
+  ```js
+  export function foo() {
+    return 'bar'
+  }
+  ```
 </div>
 ````
 
 See also <https://github.com/syntax-tree/mdast#code>
 
 ### `MDXHeading`
 
-A new `MDXHeading` estree node type is exported from `eslint-mdx` which represents code blocks in `mdx` like the following:
+A new `MDXHeading` estree node type is exported from `eslint-mdx` which represents markdown heading in `mdx` like the following:
 
 ```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
@@ -149,28 +149,22 @@ A new `MDXCode` estree node type is exported from `eslint-mdx` which represents
 
 ````mdx
 <div>
-
-```js
-export function foo() {
-  return 'bar'
-}
-```
-
+  ```js
+  export function foo() {
+    return 'bar'
+  }
+  ```
 </div>
 ````
 
 See also <https://github.com/syntax-tree/mdast#code>
 
 ### `MDXHeading`
 
-A new `MDXHeading` estree node type is exported from `eslint-mdx` which represents code blocks in `mdx` like the following:
+A new `MDXHeading` estree node type is exported from `eslint-mdx` which represents markdown heading in `mdx` like the following:
 
 ```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
@@ -149,28 +149,22 @@ A new `MDXCode` estree node type is exported from `eslint-mdx` which represents
 
 ````mdx
 <div>
-
-```js
-export function foo() {
-  return 'bar'
-}
-```
-
+  ```js
+  export function foo() {
+    return 'bar'
+  }
+  ```
 </div>
 ````
 
 See also <https://github.com/syntax-tree/mdast#code>
 
 ### `MDXHeading`
 
-A new `MDXHeading` estree node type is exported from `eslint-mdx` which represents code blocks in `mdx` like the following:
+A new `MDXHeading` estree node type is exported from `eslint-mdx` which represents markdown heading in `mdx` like the following:
 
 ```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>