Skip to content

Commit

Permalink
Generalize MDX formatting guidance
Browse files Browse the repository at this point in the history
  • Loading branch information
kylegach committed Jan 22, 2024
1 parent bb423bd commit 9a78132
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ Out of the box, Storybook provides syntax highlighting for a set of languages (e
## Why aren't my MDX stories working in Storybook?

MDX 2 introduced some changes to how the code is rendered. For example, if you have the following code block:
MDX can be picky about how your code is formatted with line breaks. This is especially true with code blocks. For example, this will break:

```
<style>{`
Expand All @@ -388,7 +388,7 @@ MDX 2 introduced some changes to how the code is rendered. For example, if you h
```

You'll need to update it to make it compatible with MDX 2+.
But this will work:

```
<style>
Expand Down

0 comments on commit 9a78132

Please sign in to comment.