docs(v2): embedding real source code in MDX as a code block (#3558)

* Example of embedding real source code in MDX as a code block

* Example of embedding real source code in MDX as a code block
This commit is contained in:
Sébastien Lorber 2020-10-08 18:39:50 +02:00 committed by GitHub
parent 39d6787471
commit d444ab75ef
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 94 additions and 0 deletions

View file

@ -61,3 +61,65 @@ import Chapter1 from './\_chapter1.md';
import Chapter2 from './\_chapter2.mdx';
<Chapter2/>
## Comments
MDX comments can be used with
```mdx
<!--
My comment
-->
```
See, nothing is displayed:
<!--
My comment
-->
## Import code block from source code file
import MyComponent from "./\_myComponent"
import BrowserWindow from '@site/src/components/BrowserWindow';
Let's say you have a React component.
You can import and use it in MDX:
```jsx title="myMarkdownFile.mdx"
import MyComponent from './myComponent';
<MyComponent />;
```
<BrowserWindow url="http://localhost:3000">
<MyComponent/>
</BrowserWindow>
But you can also display its source code directly in MDX, thanks to [Webpack raw-loader](https://webpack.js.org/loaders/raw-loader/)
```jsx title="myMarkdownFile.mdx"
import CodeBlock from '@theme/CodeBlock';
import MyComponentSource from '!!raw-loader!./myComponent';
<CodeBlock className="language-jsx">{MyComponentSource}</CodeBlock>;
```
import CodeBlock from "@theme/CodeBlock"
import MyComponentSource from '!!raw-loader!./\_myComponent';
<BrowserWindow url="http://localhost:3000">
<CodeBlock className="language-jsx">{MyComponentSource}</CodeBlock>
</BrowserWindow>