跳到主要内容

在 Tool Bank 中使用 MDX

· 阅读需 1 分钟
技术团队
Tool Bank 技术研发团队

Tool Bank 文档站支持 MDX 格式,让您可以在 Markdown 中使用 React 组件,创建交互式文档。

提示

MDX 让文档不再是静态的文字,您可以嵌入可交互的示例代码、演示组件等。

什么是 MDX

MDX 是一种可以在 Markdown 中使用 JSX 的格式。它让您可以直接在文档中编写和使用 React 组件。

在 Tool Bank 文档中使用 MDX

Tool Bank 的文档系统基于 Docusaurus,原生支持 MDX。您可以在 .mdx 文件中混合使用 Markdown 和 React 组件。

示例:交互式按钮

<button onClick={() => alert('欢迎使用 Tool Bank!')}>点击我</button>

示例:组件嵌套

您还可以使用更复杂的组件,创建丰富的交互式文档体验。

信息

更多 MDX 用法请参考 Docusaurus 官方文档