Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Dec 24, 2023
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f031b53
fix: incorrect docs due to prettier + mdx v2+ incompatible
JounQin Dec 24, 2023
0e8b43f
Create strange-balloons-turn.md
JounQin Dec 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/strange-balloons-turn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"eslint-mdx": patch
"eslint-plugin-mdx": patch
---

fix: incorrect docs due to prettier + mdx v2+ incompatible
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
6 changes: 5 additions & 1 deletion packages/eslint-mdx/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
6 changes: 5 additions & 1 deletion packages/eslint-plugin-mdx/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down