# @benedicte/html-diff 中文文档

规范地址：https://npmcn.com/package/%40benedicte/html-diff/

版本：0\.1\.0
npm 元数据更新时间：2025-05-08T15:35:07.434Z
中文译文更新时间：2026-11-07T22:03:51.809Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40benedicte/html-diff
原文对照：https://npmcn.com/package/%40benedicte/html-diff/?lang=original
项目主页：https://github.com/BenedicteGiraud/html-diff-js#readme
源码仓库：https://github.com/BenedicteGiraud/html-diff-js

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

- 包体积（解压后）：27.5 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2025-05-08T15:09:19.567Z
- 最新版本发布：2025-05-08T15:35:07.263Z
- 近 30 天下载量：9783（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 0 个）

## 中文简介

一个轻量级JavaScript库来突出两个HTML字符串之间的变化. 它将插入的内容包装为 `<ins>` 标签和删除内容 `<del>` 标记,使其在丰富的文本内容中实现可视化diff的理想.

## 安装

```sh
npm install @benedicte/html-diff
```

也可以使用：`pnpm add @benedicte/html-diff`、`yarn add @benedicte/html-diff`、`bun add @benedicte/html-diff`

## README

# html - diff

一个轻量级JavaScript库来突出两个HTML字符串之间的变化. 它将插入的内容包装为 `<ins>` 标签和删除内容 `<del>` 标记,使其在丰富的文本内容中实现可视化diff的理想.

* * *

## \* 特性

-   QQ 探测并突出显示两个 HTML 字符串之间的变化
-   ++ 围入 `<ins>` 和删除 `<del>`
-   \* 没有外部依赖关系
-   在浏览器和节点环境中工作

## 德莫语

您可以在此看到 html- diff 的现场演示: [演示](https://benedictegiraud.github.io/html-diff-js/)

## \* 安装

通过 npm 安装 :

```bash
npm install @benedicte/html-diff
```

## • API

```ts
htmlDiff(htmlBefore: string, htmlAfter: string): string
```

参数:

-   `htmlBefore` (单位:千美元)_所需经费_) — 原始 HTML 字符串
-   `htmlAfter` (单位:千美元)_所需经费_) - 已更新的 HTML 字符串

返回生成的 HTML 字符串 :

-   插入的内容被标签包裹
-   删除的内容被包裹在 ~标记~

## 实例

```ts
import { htmlDiff } from '@benedicte/html-diff';

const before = '<p>Hello world!</p>';
const after = '<p>Hello brave new world</p>';
const result = htmlDiff(before, after);

console.log(result);
// Output: <p>Hello <ins>brave new </ins>world<del>!</del></p>
```

## 许可证

麻省理工学院

## 捐款

欢迎投稿、错误报告和特性请求! 可以随意打开一个问题或提交拉动请求.

## 常见问题

### @benedicte/html-diff 是什么？

一个轻量级JavaScript库来突出两个HTML字符串之间的变化\. 它将插入的内容包装为 \<ins\> 标签和删除内容 \<del\> 标记,使其在丰富的文本内容中实现可视化diff的理想\.

### 如何安装 @benedicte/html-diff？

在项目目录运行 npm install @benedicte/html-diff，或使用 pnpm add / yarn add / bun add。

### @benedicte/html-diff 支持 TypeScript 吗？

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

### @benedicte/html-diff 支持 ESM 还是 CommonJS？

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

### @benedicte/html-diff 可以商用吗？

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

### @benedicte/html-diff 的下载量有多少？

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

### @benedicte/html-diff 还在维护吗？

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