@benedicte/html-diff

中文文档
0.1.0发布于 2025/05/08MITTypeScriptESM + CJS零依赖近 30 天下载 9783

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

中文使用文档
文档目录7 节
  1. * 特性
  2. 德莫语
  3. * 安装
  4. • API
  5. 实例
  6. 许可证
  7. 捐款

html - diff

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


* 特性

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

德莫语

您可以在此看到 html- diff 的现场演示: 演示

* 安装

通过 npm 安装 :

npm install @benedicte/html-diff

• API

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

参数:

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

返回生成的 HTML 字符串 :

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

实例

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 共发布 2 个版本,首次发布于 2025/05/08;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.1.0latest2025/05/081.5 年前
0.1.0-rc12025/05/081.5 年前

关于 @benedicte/html-diff 的常见问题

@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 和提交记录判断。