# @a2ui/markdown-it 中文文档

规范地址：https://npmcn.com/package/%40a2ui/markdown-it/

版本：0\.2\.2
npm 元数据更新时间：2026-10-17T01:02:43.739Z
中文译文更新时间：2026-11-05T17:18:21.483Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40a2ui/markdown-it
原文对照：https://npmcn.com/package/%40a2ui/markdown-it/?lang=original
项目主页：https://github.com/a2ui-project/a2ui#readme
源码仓库：https://github.com/a2ui-project/a2ui

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：138 kB，21 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：@a2ui/web\_core ^0\.14\.0
- 首次发布：2026-03-05T02:52:09.739Z
- 最新版本发布：2026-10-17T01:02:43.454Z
- 近 30 天下载量：688701（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 12 个）

## 中文简介

使用平分和净化的马克倒置渲染器.

## 安装

```sh
npm install @a2ui/markdown-it
```

也可以使用：`pnpm add @a2ui/markdown-it`、`yarn add @a2ui/markdown-it`、`bun add @a2ui/markdown-it`

## README

A2UI的Markdown渲染器使用Markdown-it并进行多姆净化.

这在所有JS的渲染器中被使用,因此配置一致. 这个 软件包提供预配置 `renderMarkdown` 插入的函数 输入每个渲染器各自的Markdown渲染器服务.

(见 `samples` 示例目录和每个渲染器的 README 如何使用这个包. )

## 发展

### 构建

运行 `yarn build` 建设工程. 建筑文物将存放在 `dist/` 目录.

### 运行单元测试

运行 `yarn test` 执行单元测试.

> \[注\] 此软件包使用 `dompurify` 它需要一个窗口对象。 在节点环境中进行单位测试, `jsdom` 在进口渲染器之前,必须在全球范围内提供.

### 代码格式

这个项目使用 [高级](https://prettier.io/) 用于代码格式化。 配置定义于 `../.prettierrc`。 。 。 .

要格式化工程中的所有文件 :

```bash
yarn format
```

要检查格式, 运行 :

```bash
npx run format:check
```

大多数IDE( 如 VS 代码) 可以配置到 **保存时的格式** 使用本地 Pretier 版本和配置。 这是推荐的工作流程.

## 常见问题

### @a2ui/markdown-it 是什么？

使用平分和净化的马克倒置渲染器\.

### 如何安装 @a2ui/markdown-it？

在项目目录运行 npm install @a2ui/markdown-it，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@a2ui/web\_core（^0\.14\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @a2ui/markdown-it 支持 TypeScript 吗？

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

### @a2ui/markdown-it 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @a2ui/markdown-it 可以商用吗？

@a2ui/markdown-it 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @a2ui/markdown-it 的下载量有多少？

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

### @a2ui/markdown-it 还在维护吗？

最新版本 0\.2\.2 发布于 2026/10/17（20 天前）；至今共发布 12 个版本，其中过去 12 个月发布了 12 个；首次发布于 2026/03/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。