Repolode
mdx-js

mdx-js/mdx

MDX 是一种可在 Markdown 文档中直接编写 JSX 组件的格式,并提供编译与框架集成。

Star
19,852
Fork
1,182
未关闭 Issue
21
最近提交
昨天

这是什么?

MDX 允许在 Markdown 文件中直接书写 JSX,可以导入图表、提示框等组件并嵌入正文。它适合需要交互式组件的长篇文档和文章写作。

本仓库包含将 MDX 编译为 JavaScript 的核心包,并提供 webpack、Rollup 等打包工具的集成,同时支持 React、Preact 和 Vue 框架。

官网提供在线 Playground 可直接体验,也有入门指南帮助将 MDX 接入现有项目。

核心功能

  • 01可在 Markdown 内容中直接嵌入 JSX 组件。
  • 02支持在 MDX 文档中导入和导出 JavaScript 值。
  • 03将 MDX 编译为 JavaScript,配合 webpack、Rollup 等打包工具使用。
  • 04可与 React、Preact 和 Vue 集成。

适用场景

  • 编写混合正文与交互组件的文档站点。
  • 撰写嵌入图表或提示框的长篇博客文章。
  • 构建以组件驱动、内容较多的 React 或 Vue 网站。

快速上手

  1. 1

    阅读入门指南,了解如何将 MDX 集成到项目中

  2. 2

    在在线演示场中试用 MDX

收录于专题

标签

常见问题

mdx 是什么?
MDX 是一种可在 Markdown 文档中直接编写 JSX 组件的格式,并提供编译与框架集成。 MDX 允许在 Markdown 文件中直接书写 JSX,可以导入图表、提示框等组件并嵌入正文。它适合需要交互式组件的长篇文档和文章写作。
mdx 可以免费使用吗?用的什么许可证?
mdx 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
mdx 还在维护吗?
活跃维护中。mdx 最近一次提交是在 2026年11月6日。
mdx 适合用来做什么?
编写混合正文与交互组件的文档站点。 撰写嵌入图表或提示框的长篇博客文章。 构建以组件驱动、内容较多的 React 或 Vue 网站。
mdx 怎么安装和运行?
阅读入门指南,了解如何将 MDX 集成到项目中 在在线演示场中试用 MDX
在哪里获取 mdx?
源代码和安装说明在 GitHub 上:https://github.com/mdx-js/mdx

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目