From 0624007271ca19ddbdabbc302c43d806db6878ba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Lorber?= Date: Fri, 29 Sep 2023 19:04:18 +0200 Subject: [PATCH] refactor(website): change date of v3 preparation blog post + add missing section (#9358) --- .../img/mdx-checker-output.png | Bin .../img/mdx2-playground-options.png | Bin .../img/social-card.png | Bin .../index.mdx | 32 ++++++++++++++++++ 4 files changed, 32 insertions(+) rename website/blog/{2023-09-25-preparing-your-site-for-docusaurus-v3 => 2023-09-29-preparing-your-site-for-docusaurus-v3}/img/mdx-checker-output.png (100%) rename website/blog/{2023-09-25-preparing-your-site-for-docusaurus-v3 => 2023-09-29-preparing-your-site-for-docusaurus-v3}/img/mdx2-playground-options.png (100%) rename website/blog/{2023-09-25-preparing-your-site-for-docusaurus-v3 => 2023-09-29-preparing-your-site-for-docusaurus-v3}/img/social-card.png (100%) rename website/blog/{2023-09-25-preparing-your-site-for-docusaurus-v3 => 2023-09-29-preparing-your-site-for-docusaurus-v3}/index.mdx (94%) diff --git a/website/blog/2023-09-25-preparing-your-site-for-docusaurus-v3/img/mdx-checker-output.png b/website/blog/2023-09-29-preparing-your-site-for-docusaurus-v3/img/mdx-checker-output.png similarity index 100% rename from website/blog/2023-09-25-preparing-your-site-for-docusaurus-v3/img/mdx-checker-output.png rename to website/blog/2023-09-29-preparing-your-site-for-docusaurus-v3/img/mdx-checker-output.png diff --git a/website/blog/2023-09-25-preparing-your-site-for-docusaurus-v3/img/mdx2-playground-options.png b/website/blog/2023-09-29-preparing-your-site-for-docusaurus-v3/img/mdx2-playground-options.png similarity index 100% rename from website/blog/2023-09-25-preparing-your-site-for-docusaurus-v3/img/mdx2-playground-options.png rename to website/blog/2023-09-29-preparing-your-site-for-docusaurus-v3/img/mdx2-playground-options.png diff --git a/website/blog/2023-09-25-preparing-your-site-for-docusaurus-v3/img/social-card.png b/website/blog/2023-09-29-preparing-your-site-for-docusaurus-v3/img/social-card.png similarity index 100% rename from website/blog/2023-09-25-preparing-your-site-for-docusaurus-v3/img/social-card.png rename to website/blog/2023-09-29-preparing-your-site-for-docusaurus-v3/img/social-card.png diff --git a/website/blog/2023-09-25-preparing-your-site-for-docusaurus-v3/index.mdx b/website/blog/2023-09-29-preparing-your-site-for-docusaurus-v3/index.mdx similarity index 94% rename from website/blog/2023-09-25-preparing-your-site-for-docusaurus-v3/index.mdx rename to website/blog/2023-09-29-preparing-your-site-for-docusaurus-v3/index.mdx index 28edde2617..7a5c288beb 100644 --- a/website/blog/2023-09-25-preparing-your-site-for-docusaurus-v3/index.mdx +++ b/website/blog/2023-09-29-preparing-your-site-for-docusaurus-v3/index.mdx @@ -212,6 +212,38 @@ http://localhost:3000 ::: +#### Lower-case MDXComponent mapping + +For users providing a [custom `MDXComponent`mapping](/docs/3.0.0-beta.0/markdown-features/react#mdx-component-scope), components are now "sandboxed": + +- a `MDXComponent` mapping for `h1` only gets used for `# hi` but not for `

hi

` +- a **lower-cased** custom element name will not be substituted by its respective `MDXComponent` component anymore + +:::danger visual difference + +Your [`MDXComponent` component mapping](/docs/3.0.0-beta.0/markdown-features/react#mdx-component-scope) might not be applied as before, and your custom components might no longer be used. + +::: + +:::tip How to prepare + +For native Markdown elements, you can keep using **lower-case**: `p`, `h1`, `img`, `a`... + +For any other element, **use upper-case names**. + +```diff title="src/theme/MDXComponents.js" + import MDXComponents from '@theme-original/MDXComponents'; + + export default { + ...MDXComponents, + p: (props) =>

+- myElement: (props) =>

, ++ MyElement: (props) =>
, + }; +``` + +::: + #### Unintended extra paragraphs In MDX v2, it is now possible to interleave JSX and Markdown more easily without requiring extra line breaks. Writing content on multiple lines can also produce new expected `

` tags.