From 1585d9a0b493e7ebea550e831f78b35795746bce Mon Sep 17 00:00:00 2001 From: Tatsunori Uchino Date: Thu, 23 May 2024 23:03:59 +0900 Subject: [PATCH] docs: suggest using `{<...>...}` if don't use Markdown in migration --- website/docs/migration/v3.mdx | 13 +++++++++++++ .../versioned_docs/version-3.3.2/migration/v3.mdx | 13 +++++++++++++ 2 files changed, 26 insertions(+) diff --git a/website/docs/migration/v3.mdx b/website/docs/migration/v3.mdx index b3f4cad270b7..fc2e2e7e31c5 100644 --- a/website/docs/migration/v3.mdx +++ b/website/docs/migration/v3.mdx @@ -357,6 +357,19 @@ If you don't want an extra `

` tag, refactor content on a case by case basis t ``` +You can also wrap such content with `{` and `}` to avoid extra `

` tags if you don't intend to use Markdown syntax there yet. + +```diff +-

++{
+ My alt +
+ My image caption +
+-
++
} +``` + ::: #### Unintended usage of directives diff --git a/website/versioned_docs/version-3.3.2/migration/v3.mdx b/website/versioned_docs/version-3.3.2/migration/v3.mdx index b3f4cad270b7..fc2e2e7e31c5 100644 --- a/website/versioned_docs/version-3.3.2/migration/v3.mdx +++ b/website/versioned_docs/version-3.3.2/migration/v3.mdx @@ -357,6 +357,19 @@ If you don't want an extra `

` tag, refactor content on a case by case basis t ``` +You can also wrap such content with `{` and `}` to avoid extra `

` tags if you don't intend to use Markdown syntax there yet. + +```diff +-

++{
+ My alt +
+ My image caption +
+-
++
} +``` + ::: #### Unintended usage of directives