Skip to content

Commit c5425c7

Browse files
committed
Report the state of Prettier support
Closes #455
1 parent 9b3b9ce commit c5425c7

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

packages/vscode-mdx/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
* [Custom Languages in Code Blocks](#custom-languages-in-code-blocks)
2121
* [ESLint](#eslint)
2222
* [Auto-close tags](#auto-close-tags)
23+
* [Prettier](#prettier)
2324
* [Sponsor](#sponsor)
2425
* [Changelog](#changelog)
2526
* [License](#license)
@@ -177,6 +178,17 @@ If you want VS Code to automatically close tags while you type, install
177178
}
178179
```
179180

181+
## Prettier
182+
183+
[Prettier][] supports MDX 1, but MDX 2 and 3
184+
[are not officially supported][prettier issue] yet.
185+
We recommend against formatting MDX files with Prettier.
186+
To opt out, add the following line to your `.prettierignore` file:
187+
188+
```ignore
189+
*.mdx
190+
```
191+
180192
## Sponsor
181193

182194
See [§ Sponsor][sponsor] on our site for how to help financially.
@@ -297,6 +309,10 @@ Detailed changes for each release are documented in [CHANGELOG.md](./CHANGELOG.m
297309

298310
[openvsx-badge]: https://img.shields.io/open-vsx/dt/unifiedjs/vscode-mdx
299311

312+
[prettier]: https://prettier.io
313+
314+
[prettier issue]: https://github.com/prettier/prettier/issues/12209
315+
300316
[sponsor]: https://mdxjs.com/community/sponsor/
301317

302318
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

0 commit comments

Comments
 (0)