在 MDX 中,所有 .mdx
文件都会编译为 React 组件,这意味着它们可以被当做 React 组件使用,也可以自由使用 React 组件。例如:
它将被渲染为:
测试 MDX 片段和 React 组件的使用。
这是来自 mdx 的片段。
这是来自 tsx 的组件
你可以在 .mdx
文件中使用 Rspress 提供的 内置组件 或安装一些 React 组件库来丰富你的文档。
在 docs 目录 中,使用 MDX 片段或 React 组件要通过 route.exclude 配置从路由中排除。为了使用方便,我们约定以 "_" 开头的文件会被默认排除,通过 route.excludeConvention。
你也可以将组件放到 docs 目录以外的相邻目录,例如:
它将被渲染为:
这是一段文本
它将被渲染为:
这是一段在 tsx 中的内容,不过可以使用代码块
样式。
.tsx
组件会导致一些静态信息难以提取,比如本地搜索索引。
更推荐使用 .mdx
文件来编写文档内容,使用 .tsx
文件来编写需交互的动态内容。