From c63295a2532457516a3dde751bd6ef42933ada3e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Lorber?= Date: Fri, 18 Jun 2021 17:59:51 +0200 Subject: [PATCH] docs(v2): wrap mdx usage in mdx-code-block (#5007) --- website/docs/guides/docs/docs-create-doc.mdx | 2 ++ .../docs/guides/markdown-features/markdown-features-react.mdx | 4 ++++ .../version-2.0.0-beta.1/guides/docs/docs-create-doc.mdx | 2 ++ .../guides/markdown-features/markdown-features-react.mdx | 4 ++++ 4 files changed, 12 insertions(+) diff --git a/website/docs/guides/docs/docs-create-doc.mdx b/website/docs/guides/docs/docs-create-doc.mdx index 839335be3f..4abbec3db2 100644 --- a/website/docs/guides/docs/docs-create-doc.mdx +++ b/website/docs/guides/docs/docs-create-doc.mdx @@ -52,6 +52,7 @@ With `{#custom-id}` syntax you can set your own header id. This will render in the browser as follows: +```mdx-code-block import BrowserWindow from '@site/src/components/BrowserWindow'; @@ -81,3 +82,4 @@ The headers are well-spaced so that the hierarchy is clear. With {#custom-id} syntax you can set your own header id. +``` diff --git a/website/docs/guides/markdown-features/markdown-features-react.mdx b/website/docs/guides/markdown-features/markdown-features-react.mdx index b4b8912968..982b75a90d 100644 --- a/website/docs/guides/markdown-features/markdown-features-react.mdx +++ b/website/docs/guides/markdown-features/markdown-features-react.mdx @@ -83,6 +83,7 @@ import MyComponentSource from '!!raw-loader!./myComponent'; {MyComponentSource}; ``` +```mdx-code-block import CodeBlock from '@theme/CodeBlock'; import MyComponentSource from '!!raw-loader!@site/src/pages/examples/_myComponent'; @@ -93,6 +94,7 @@ import MyComponentSource from '!!raw-loader!@site/src/pages/examples/_myComponen
+``` :::note @@ -116,6 +118,7 @@ import Intro from './markdown-features-intro.mdx'; ; ``` +```mdx-code-block import Intro from './markdown-features-intro.mdx'; @@ -125,6 +128,7 @@ import Intro from './markdown-features-intro.mdx';
+``` This way, you can reuse contents among multiple pages and avoid duplicating materials. diff --git a/website/versioned_docs/version-2.0.0-beta.1/guides/docs/docs-create-doc.mdx b/website/versioned_docs/version-2.0.0-beta.1/guides/docs/docs-create-doc.mdx index 839335be3f..4abbec3db2 100644 --- a/website/versioned_docs/version-2.0.0-beta.1/guides/docs/docs-create-doc.mdx +++ b/website/versioned_docs/version-2.0.0-beta.1/guides/docs/docs-create-doc.mdx @@ -52,6 +52,7 @@ With `{#custom-id}` syntax you can set your own header id. This will render in the browser as follows: +```mdx-code-block import BrowserWindow from '@site/src/components/BrowserWindow'; @@ -81,3 +82,4 @@ The headers are well-spaced so that the hierarchy is clear. With {#custom-id} syntax you can set your own header id. +``` diff --git a/website/versioned_docs/version-2.0.0-beta.1/guides/markdown-features/markdown-features-react.mdx b/website/versioned_docs/version-2.0.0-beta.1/guides/markdown-features/markdown-features-react.mdx index b4b8912968..982b75a90d 100644 --- a/website/versioned_docs/version-2.0.0-beta.1/guides/markdown-features/markdown-features-react.mdx +++ b/website/versioned_docs/version-2.0.0-beta.1/guides/markdown-features/markdown-features-react.mdx @@ -83,6 +83,7 @@ import MyComponentSource from '!!raw-loader!./myComponent'; {MyComponentSource}; ``` +```mdx-code-block import CodeBlock from '@theme/CodeBlock'; import MyComponentSource from '!!raw-loader!@site/src/pages/examples/_myComponent'; @@ -93,6 +94,7 @@ import MyComponentSource from '!!raw-loader!@site/src/pages/examples/_myComponen
+``` :::note @@ -116,6 +118,7 @@ import Intro from './markdown-features-intro.mdx'; ; ``` +```mdx-code-block import Intro from './markdown-features-intro.mdx'; @@ -125,6 +128,7 @@ import Intro from './markdown-features-intro.mdx';
+``` This way, you can reuse contents among multiple pages and avoid duplicating materials.