MDX

在 Markdown 里写 JSX,让文档拥有组件能力。

简介

把 Markdown 与 JSX 结合的内容格式和工具链,让文档可以直接使用项目组件,适合组件库文档、教程和需要交互示例的技术内容。

安装

npm install @mdx-js/rollup

命令用于快速开始,具体版本与配置请以官方文档为准。

适用场景

  • 为组件库编写带真实示例的文档
  • 在教程中嵌入可运行组件
  • 把文档纳入前端构建流程

特点

  • Markdown 的自然表达与组件能力结合
  • 示例可以和源码共享同一组件
  • 与现代打包工具集成路径明确