注意:这个答案适用于 docusaurus 的 v2。
根据 docusaurus 文档介绍部分,docusaurus 由 MDX 提供支持。
通过 JSX 和 React 编写交互式组件,嵌入 Markdown
这允许开发人员在 Markdown 文件中编写 JSX,并使用与在 React 项目中相同的方式使用 React 组件,因此您所要做的就是在项目中添加react-treebeard作为依赖项,然后在 doc/mark_down_file.md 导入中添加并在您添加的示例中以相同的方式使用 treebeard。
我已经有一个设置为使用 treebeard 库的 codesandbox.io 项目,您可以在此处查看我是如何做到的或实时查看
这是我导入和使用 Treebeard 的片段:
---
id: treebeard
title: Tree beard
---
import TreeView from "../src/components/TreeView.js"
You can write JSX and use React components within your Markdown thanks to [MDX](https://mdxjs.com/).
export const Highlight = ({children, color}) => (
<span
style={{
backgroundColor: color,
borderRadius: '2px',
color: '#fff',
padding: '0.2rem',
}}>
{children}
</span>
);
----
<TreeView />
----
<Highlight color="#25c2a0">Docusaurus green</Highlight> and <Highlight color="#1877F2">Facebook blue</Highlight> are my favorite colors.
I can write **Markdown** alongside my _JSX_!
检查codesandbox的代码,你可以找到MDX文件的代码docs/treebread.mdx
和Treebread
代码
src/components/TreeView.js