@ant-design/x-markdown

中文文档
2.10.0发布于 2026/10/29MITTypeScriptESM + CJS近 30 天下载 14.5万

@ ant- dedesign/ x- markdown 的占位符

中文使用文档
文档目录13 节
  1. * 特性
  2. 兼容性
  3. 支持的 Markdown 光谱
  4. * 安装
  5. 使用 npm,纱线, pnpm, bun, 或自定义
  6. 浏览器导入
  7. 示例
  8. 插件
  9. 主题
  10. 企业级LLM组件 离开盒子
  11. QQ 连接到模型代理并有效管理数据流
  12. 如何贡献
  13. 社区支助

蚂蚁设计 X Markdown

流畅、可扩展和高性能的Markdown渲染器

CI status codecov NPM version

NPM downloads antd Follow zhihu

更改日志 • 妇女 报告错误 • 妇女 请求特性 · 英语 页:1

* 特性

用途 marked 作为底部标记下渲染器,具有标记的所有特征.

  • 🚀生为快.
  • LLM Markdown 渲染解决方案.
  • QQ 用于解析 Markdown 的低等编译器, 没有长期缓存或屏蔽 .
  • QQ 轻量级, 执行所有支持的样式并标记下规格 .
  • 默认安全,没有危险的Set InnerHTML XSS攻击.
  • QQ自定义的组件, 传出自己的组件来替换<h2> for ^ hi.
  • QQ 丰富的插件, 许多插件可用 .
  • QQ相容性,100%通用马克,100%GFM插件支持.

兼容性

符合 marked。为了更好地实现整体降标相容性,可以根据需要定制多填充.

Edge 边缘Firefox 火花Chrome 颜色Safari 萨法里Opera 歌剧
>=92第90条>=92页:1>= 78

支持的 Markdown 光谱

* 安装

使用 npm,纱线, pnpm, bun, 或自定义

我们建议使用 无, (中文(简体) ), 线条, (中文(简体) ), 小时, (中文(简体) ), 包头,或 乌托 促进发展. 这使发展和安全生产部署容易调试,享受整个生态系统和工具链的好处。 如果你的网络很慢 请试试 时间。 。 。 .

npm install @ant-design/x-markdown
yarn add @ant-design/x-markdown
pnpm add @ant-design/x-markdown
ut install @ant-design/x-markdown

浏览器导入

使用 script 财务报告和审定财务报表 link 在浏览器中直接导入文件的标签,并使用全局变量 XMarkdown。 。 。 .

我们提供 x-markdown.js, (中文(简体) ), x-markdown.min.js,以及 x-markdown.min.js.map 在 npm 软件包的 dist 目录中.

强烈建议不使用已建文件,因为这样可以防止按需加载,并使得对基础依赖模块难以获得快速的bug修复.

说明: x-markdown.js, (中文(简体) ), x-markdown.min.js,以及 x-markdown.min.js.map 取决于 react 财务报告和审定财务报表 react-dom请确保提前导入这些文件.

示例

import React from 'react';
import { XMarkdown } from '@ant-design/x-markdown';
const content = `
# Hello World

### Welcome to XMarkdown!

- Item 1
- Item 2
- Item 3
`;

const App = () => <XMarkdown content={content} />;

export default App;

插件

@ant-design/x-markdown 提供了丰富的插件集。 你可以通过 plugins 道具 (英语). 见 插件收藏库 详细情况.

主题

@ant-design/x-markdown 提供了几个主题。 见 主题 详细情况.

企业级LLM组件 离开盒子

@ant-design/x 基于 RICH 交互范式,为不同的相互作用阶段提供一组丰富的原子组件,帮助您灵活地构建自己的AI应用. 详情见 这里。 。 。 .

QQ 连接到模型代理并有效管理数据流

@ant-design/x-sdk 提供一套实用的 API来帮助开发者管理出框的AI 应用程序数据流. 详情见 这里。 。 。 .

如何贡献

在以任何形式参加之前,请先阅读 贡献者指南。如果你想作出贡献,请随意提交 拉请求 或者说 报告错误。 。 。 .

我们强烈推荐阅读 如何问问题 明智的方式, (中文(简体) ), 开放源码社区如何提问, (中文(简体) ), 如何有效报告臭虫,以及 如何向开源项目提交无法回答的问题更好的问题更有可能得到帮助.

社区支助

如果在使用过程中遇到问题,您可通过下列渠道寻求帮助。 我们还鼓励有经验的用户通过这些渠道帮助新来者.

在询问关于GitHub讨论的问题时,建议使用 Q&A 标签.

  1. GitHub 讨论
  2. GitHub 问题
Contribution Leaderboard

版本与发布记录

@ant-design/x-markdown 共发布 41 个版本,首次发布于 2025/08/05;过去 12 个月发布了 27 个版本。

版本发布日期距今
2.10.0latest2026/10/297 天前
2.9.02026/07/283 个月前
2.8.02026/06/084 个月前
2.7.02026/04/306 个月前
2.6.0beta2026/04/176 个月前
2.5.02026/03/317 个月前

其他发布通道:alpha → 2.0.0-alpha.16,beta → 2.6.0。

关于 @ant-design/x-markdown 的常见问题

@ant-design/x-markdown 是什么?

@ ant- dedesign/ x- markdown 的占位符

如何安装 @ant-design/x-markdown?

在项目目录运行 npm install @ant-design/x-markdown,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=18.0.0)、react-dom(>=18.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@ant-design/x-markdown 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@ant-design/x-markdown 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@ant-design/x-markdown 可以商用吗?

@ant-design/x-markdown 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@ant-design/x-markdown 的下载量有多少?

根据 npm 官方下载统计,@ant-design/x-markdown 在 2026/10/06 – 2026/11/04 这 30 天内被下载 144,814 次,日均约 4,827 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@ant-design/x-markdown 还在维护吗?

最新版本 2.10.0 发布于 2026/10/29(7 天前);至今共发布 41 个版本,其中过去 12 个月发布了 27 个;首次发布于 2025/08/05。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。