普通.md
# plain markdown
一些.mdx
# some mdx file
include './plain.md'
结果文件
# some mdx file
# plain markdown
如何使用 mdxjs 做这样的事情?
哦,这实际上在他们的文档中是正确的。前段时间被称为嵌入。
import License from './license.md'
import Contributing from './docs/contributing.mdx'
# Hello, world!
<License />
---
<Contributing />
为此,您应该在捆绑程序中激活“嵌入”功能(例如:webpack)
如果您使用故事书,您可以按照以下步骤操作:
1- 在您的 main.js 文件中,在
"@storybook/addon-docs"插件上设置
{ transcludeMarkdown: true }
。
// .storybook/main.js
module.exports = {
addons: [
{
name: "@storybook/addon-docs",
options: { transcludeMarkdown: true },
},
],
// ...
};
2- 将 .md 导入 .mdx 文件并像组件一样渲染它
//Example.stories.mdx
import MyMarkdown from './MyMarkdown.md'
...
<MyMarkdown />