Skip to content

Commit 74f325c

Browse files
committed
Update README.md
1 parent 9c33d96 commit 74f325c

1 file changed

Lines changed: 29 additions & 1 deletion

File tree

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ So, for example, if you configure it like this for JavaScript formatting, only `
2222

2323
However, you can overcome this limitation by adding `prettier-plugin-merge` as the last plugin.
2424

25-
<!-- prettier-ignore -->
2625
```diff
2726
{
2827
"plugins": [
@@ -101,6 +100,35 @@ export default {
101100
};
102101
```
103102

103+
### Markdown/MDX Override
104+
105+
This plugin does not support Markdown and MDX, but if this plugin supports a language inside code blocks (e.g. Vue), unintended formatting may occur inside the code blocks.
106+
107+
To prevent unintended formatting, you can use configuration overrides for Markdown and MDX.
108+
109+
JSON example:
110+
111+
```json
112+
{
113+
"plugins": [
114+
"prettier-plugin-brace-style",
115+
"@trivago/prettier-plugin-sort-imports",
116+
"prettier-plugin-merge"
117+
],
118+
"braceStyle": "stroustrup",
119+
"importOrder": ["<THIRD_PARTY_MODULES>", "^@[^/]+/(.*)$", "^@/(.*)$", "^[./]"],
120+
"importOrderSeparation": true,
121+
"overrides": [
122+
{
123+
"files": ["*.md", "*.mdx"],
124+
"options": {
125+
"plugins": []
126+
}
127+
}
128+
]
129+
}
130+
```
131+
104132
## Version correlation with sibling plugins
105133

106134
Starting with `0.6.0`, when there is a minor release on one side, I plan to reflect that change on the other side as well if possible.

0 commit comments

Comments
 (0)