# @ant-design/x-markdown 中文文档 规范地址：https://npmcn.com/package/%40ant-design/x-markdown/ 版本：2\.10\.0 npm 元数据更新时间：2026-10-29T09:09:37.324Z 中文译文更新时间：2026-11-06T06:02:42.728Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40ant-design/x-markdown 原文对照：https://npmcn.com/package/%40ant-design/x-markdown/?lang=original 项目主页：https://x.ant.design/x-markdowns/introduce 源码仓库：https://github.com/ant-design/x ## 关键信息（来自 npm 元数据） - 包体积（解压后）：6.2 MB，207 个文件 - 模块格式：ESM + CJS - TypeScript 类型：包内自带 - 运行依赖：5 个 - peer 依赖：react \>=18\.0\.0，react-dom \>=18\.0\.0 - 首次发布：2025-08-05T08:03:03.819Z - 最新版本发布：2026-10-29T09:09:37.119Z - 近 30 天下载量：144814（2026-10-06 至 2026-11-04，npm 官方下载统计） - 已发布版本数：41（近 12 个月 27 个） ## 中文简介 @ ant- dedesign/ x- markdown 的占位符 ## 安装 ```sh npm install @ant-design/x-markdown ``` 也可以使用：`pnpm add @ant-design/x-markdown`、`yarn add @ant-design/x-markdown`、`bun add @ant-design/x-markdown` ## README ![](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*eco6RrQhxbMAAAAAAAAAAAAADgCCAQ/original) # 蚂蚁设计 X Markdown 流畅、可扩展和高性能的Markdown渲染器 [![CI status](https://github.com/ant-design/x/actions/workflows/main.yml/badge.svg)](https://github.com/ant-design/x/actions/workflows/main.yml) [![codecov](https://codecov.io/gh/ant-design/x/graph/badge.svg?token=wrCCsyTmdi)](https://codecov.io/gh/ant-design/x) [![NPM version](https://img.shields.io/npm/v/@ant-design/x-markdown.svg?style=flat-square)](https://www.npmjs.com/package/@ant-design/x-markdown) [![NPM downloads](https://img.shields.io/npm/dm/@ant-design/x-markdown.svg?style=flat-square)](https://npmjs.org/package/@ant-design/x-markdown) [![](https://badgen.net/bundlephobia/minzip/@ant-design/x-markdown?style=flat-square)](https://bundlephobia.com/package/@ant-design/x-markdown) [![antd](https://img.shields.io/badge/-Ant%20Design-blue?labelColor=black&logo=antdesign&style=flat-square)](https://ant.design/) [![Follow zhihu](https://img.shields.io/badge/-Ant%20Design-white?logo=zhihu)](https://www.zhihu.com/column/c_1564262000561106944) [更改日志](https://npmcn.com/package/%40ant-design/x-markdown/CHANGELOG.md) • 妇女 [报告错误](https://github.com/ant-design/x/issues/new?template=bug-report.yml) • 妇女 [请求特性](https://github.com/ant-design/x/issues/new?template=bug-feature-request.yml) · 英语 [页:1](https://npmcn.com/package/%40ant-design/x-markdown/README-zh_CN.md) ## \* 特性 用途 [`marked`](https://github.com/markedjs/marked) 作为底部标记下渲染器,具有标记的所有特征. - 🚀生为快. - LLM Markdown 渲染解决方案. - QQ 用于解析 Markdown 的低等编译器, 没有长期缓存或屏蔽 . - QQ 轻量级, 执行所有支持的样式并标记下规格 . - 默认安全,没有危险的Set InnerHTML XSS攻击. - QQ自定义的组件, 传出自己的组件来替换

for ^ hi. - QQ 丰富的插件, 许多插件可用 . - QQ相容性,100%通用马克,100%GFM插件支持. ## 兼容性 符合 [`marked`](https://github.com/markedjs/marked)。为了更好地实现整体降标相容性,可以根据需要定制多填充. | ![Edge](https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png) 边缘 | ![Firefox](https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png) 火花 | ![Chrome](https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png) 颜色 | ![Safari](https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png) 萨法里 | ![Opera](https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png) 歌剧 | | --- | --- | --- | --- | --- | | \>=92 | 第90条 | \>=92 | 页:1 | \>= 78 | ## 支持的 Markdown 光谱 - [标记为 1.0.0](https://daringfireball.net/projects/markdown/) - [普通马克](https://github.com/commonmark/commonmark-spec/wiki/Markdown-Flavors) - [GitHub 平地标记( GFM)](https://github.github.com/gfm/) ## \* 安装 ### 使用 npm,纱线, pnpm, bun, 或自定义 **我们建议使用 [无](https://www.npmjs.com/), (中文(简体) ), [线条](https://github.com/yarnpkg/yarn/), (中文(简体) ), [小时](https://pnpm.io/), (中文(简体) ), [包头](https://bun.sh/),或 [乌托](https://github.com/umijs/mako/tree/next) 促进发展.** 这使发展和安全生产部署容易调试,享受整个生态系统和工具链的好处。 如果你的网络很慢 请试试 [时间](https://github.com/cnpm/cnpm)。 。 。 . ```bash npm install @ant-design/x-markdown ``` ```bash yarn add @ant-design/x-markdown ``` ```bash pnpm add @ant-design/x-markdown ``` ```bash 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`请确保提前导入这些文件. ## 示例 ```tsx 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 = () => ; export default App; ``` ## 插件 `@ant-design/x-markdown` 提供了丰富的插件集。 你可以通过 `plugins` 道具 (英语). 见 [插件收藏库](https://npmcn.com/package/%40ant-design/x/docs/x-markdown/plugins.md) 详细情况. ## 主题 `@ant-design/x-markdown` 提供了几个主题。 见 [主题](https://npmcn.com/package/%40ant-design/x/docs/x-markdown/themes.md) 详细情况. ## 企业级LLM组件 离开盒子 `@ant-design/x` 基于 RICH 交互范式,为不同的相互作用阶段提供一组丰富的原子组件,帮助您灵活地构建自己的AI应用. 详情见 [这里](https://npmcn.com/package/%40ant-design/x/README.md)。 。 。 . ## QQ 连接到模型代理并有效管理数据流 `@ant-design/x-sdk` 提供一套实用的 API来帮助开发者管理出框的AI 应用程序数据流. 详情见 [这里](https://npmcn.com/package/%40ant-design/x-sdk/README.md)。 。 。 . ## 如何贡献 在以任何形式参加之前,请先阅读 [贡献者指南](https://github.com/ant-design/ant-design/blob/master/.github/CONTRIBUTING.md)。如果你想作出贡献,请随意提交 [拉请求](https://github.com/ant-design/ant-design/pulls) 或者说 [报告错误](http://new-issue.ant.design/)。 。 。 . > 我们强烈推荐阅读 [如何问问题 明智的方式](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way), (中文(简体) ), [开放源码社区如何提问](https://github.com/seajs/seajs/issues/545), (中文(简体) ), [如何有效报告臭虫](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs.html),以及 [如何向开源项目提交无法回答的问题](https://zhuanlan.zhihu.com/p/25795393)更好的问题更有可能得到帮助. ## 社区支助 如果在使用过程中遇到问题,您可通过下列渠道寻求帮助。 我们还鼓励有经验的用户通过这些渠道帮助新来者. 在询问关于GitHub讨论的问题时,建议使用 `Q&A` 标签. 1. [GitHub 讨论](https://github.com/ant-design/x/discussions) 2. [GitHub 问题](https://github.com/ant-design/x/issues) [![Contribution Leaderboard](https://openomy.app/svg?repo=ant-design/x&chart=bubble&latestMonth=3)](https://openomy.app/github/ant-design/x) ## 常见问题 ### @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 和提交记录判断。