Skip to content

Commit

Permalink
docs: suggest using {<...>...</...>} if don't use Markdown in migra…
Browse files Browse the repository at this point in the history
…tion
  • Loading branch information
tats-u committed May 23, 2024
1 parent b73ad1e commit 1585d9a
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
13 changes: 13 additions & 0 deletions website/docs/migration/v3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,19 @@ If you don't want an extra `<p>` tag, refactor content on a case by case basis t
</figure>
```

You can also wrap such content with `{` and `}` to avoid extra `<p>` tags if you don't intend to use Markdown syntax there yet.

```diff
-<figure>
+{<figure>
<img src="/img/myImage.png" alt="My alt" />
<figcaption>
My image caption
</figcaption>
-</figure>
+</figure>}
```

:::

#### Unintended usage of directives
Expand Down
13 changes: 13 additions & 0 deletions website/versioned_docs/version-3.3.2/migration/v3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,19 @@ If you don't want an extra `<p>` tag, refactor content on a case by case basis t
</figure>
```

You can also wrap such content with `{` and `}` to avoid extra `<p>` tags if you don't intend to use Markdown syntax there yet.

```diff
-<figure>
+{<figure>
<img src="/img/myImage.png" alt="My alt" />
<figcaption>
My image caption
</figcaption>
-</figure>
+</figure>}
```

:::

#### Unintended usage of directives
Expand Down

0 comments on commit 1585d9a

Please sign in to comment.