text-highlighter-plugin

文本高亮插件 (Text Highlighter)

一个简单的文本高亮插件，可以轻松地为网页中的文本添加高亮效果。

功能特点

• 支持自定义高亮颜色
• 支持自定义背景色
• 支持自定义样式类名
• 支持清除高亮效果
• 支持多次高亮不同文本

安装

npm install text-highlighter-plugin

使用方法

基本使用

import TextHighlighter from 'text-highlighter-plugin';

// 创建实例
const highlighter = new TextHighlighter({
  color: '#ff0000',           // 文字颜色（可选）
  backgroundColor: '#ffeb3b', // 背景色（可选）
  className: 'highlight'      // 自定义类名（可选）
});

// 高亮文本
const element = document.getElementById('content');
highlighter.highlight(element, '要高亮的文本');

// 清除高亮
highlighter.removeHighlight(element);

完整示例

可以查看 demo/index.html 文件获取完整的使用示例。

开发指南

1. 克隆仓库：

git clone [仓库地址]

2. 安装依赖：

npm install

3. 开发模式：

npm run dev

4. 构建生产版本：

npm run build

npm包更新指南

1. 修改版本号： 在 package.json 中更新 version 字段，遵循语义化版本规范：

   • 主版本号：不兼容的API修改
   • 次版本号：向下兼容的功能性新增
   • 修订号：向下兼容的问题修正

2. 登录npm（如果未登录）：

npm login

3. 构建最新版本：

npm run build

4. 发布新版本：

npm publish

5. 更新说明： 每次更新时，建议在README.md中的更新日志部分添加新版本的更新内容。

更新日志

1.0.0

• 初始版本
• 支持基本的文本高亮功能
• 支持自定义样式
• 支持清除高亮

许可证

ISC