README 文档优化日志

[文档优化] 2026-05-11

优化范围

  • README.md(library/README.md)- 从零生成
  • README_zh.md(library/README_zh.md)- 从零生成

优化内容

README_zh.md

  • [简介] 添加库的核心功能描述,明确说明这是 Android HtmlSpanner 的鸿蒙化等价迁移实现
  • [效果展示] 添加效果展示占位符
  • [下载安装] 使用标准的 ohpm 安装命令
  • [约束与限制] 添加兼容性信息(IDE 版本、SDK API 版本、ROM 版本)和网络权限说明
  • [使用示例] 添加 4 个典型使用场景示例:基础用法、链接点击处理、自定义标签处理、编译选项使用
  • [使用说明] 详细说明 HtmlSpannerText 组件和 HtmlSpanner 类的使用方法
  • [使用说明] 添加 CSS 支持、图片加载、表格支持、取消解析等高级功能说明
  • [接口说明] 完整列出 HtmlSpanner 类的所有主要 API 方法
  • [接口说明] 展开 HtmlSpannerOptions 配置字段为独立表格
  • [接口说明] 展开 CancellationCallback 接口为独立表格
  • [接口说明] 展开 HtmlSpannerText 组件属性为独立表格
  • [关于混淆] 添加混淆排除规则
  • [目录结构] 添加完整的目录结构说明
  • [贡献代码] 添加贡献代码章节
  • [开源协议] 添加 Apache License 2.0 协议说明
  • [第三方依赖] 列出 @ohos/htmlparser2 和 @ohos/postcss 依赖

README.md

  • [Introduction] 翻译中文文档简介
  • [Demo] 翻译效果展示章节
  • [Installation] 翻译下载安装章节
  • [Constraints and Limitations] 翻译约束与限制章节
  • [Usage Examples] 翻译使用示例章节
  • [Usage Guide] 翻译使用说明章节
  • [API Reference] 翻译接口说明章节
  • [Obfuscation] 翻译关于混淆章节
  • [Directory Structure] 翻译目录结构章节
  • [Contributing] 翻译贡献代码章节
  • [License] 翻译开源协议章节
  • [Third-Party Dependencies] 翻译第三方依赖章节

issue 分析结果

注意:本次文档优化未执行 GitCode issue 分析。 原因:GitCode 仓库暂无 issues(0/100)。 建议:当仓库有用户反馈后,可重新执行技能以基于用户反馈进一步完善文档。

新增内容

  • library/README_zh.md - 中文文档(从零生成)
  • library/README.md - 英文文档(从零生成)

质量检查结果

✅ 所有检查项均通过:

  • 标题命名规范
  • 简介无平台限定词
  • 安装命令格式正确
  • 兼容性信息完整
  • 使用示例代码规范
  • 接口主表格完整
  • 接口配置字段完整
  • 主要 API 均有代码示例
  • 措辞质量达标
  • 注意事项格式规范
  • 链接有效
  • 英中文档一致
  • 混淆章节存在
  • ohpm 命令不含组织名重复