Obsidian Plugin - Better Image Helper

English: This plugin provides a comprehensive image helper for Obsidian. Currently features OCR (Optical Character Recognition) for images using Alibaba Cloud OCR API, with plans to add image rotation, scaling, and other operations in future updates. Designed to provide the best possible user experience for image handling in Obsidian.

Obsidian 插件 - 更好的图片处理助手

全面的图片助手插件，目前实现了OCR文字识别功能，在Obsidian中右键点击图片即可识别图片中的文字。未来将添加图片旋转、放缩等更多图片处理功能，致力于为Obsidian用户提供最佳的图片处理体验。

✨ 功能特点

• 便捷识别：在 Obsidian 中右键点击图片，快速识别图片中的文字
• 多模式支持：
  • 阅读模式 (Reading Mode)
  • 编辑模式 (Live Preview)
  • 源码模式 (Source Mode) 下识别 Markdown 图片语法
  • 附件管理器中右键图片文件
• 高质量识别：使用阿里云 OCR API 进行识别，识别速度快，准确率高
• 优雅展示：
  • 识别结果以美观的模态窗口呈现
  • 支持实时编辑并提供字符/词数统计
  • 可直接复制文本或创建为新笔记
  • 显示图片预览，支持点击查看原图
• 灵活配置：支持配置多种 OCR 服务及其参数

📥 安装

从 Obsidian 社区插件库安装

1. 打开 Obsidian 设置
2. 点击 "社区插件" > "浏览"
3. 搜索 "Image OCR"
4. 安装并启用插件

手动安装

1. 下载最新的 release 文件
2. 解压缩后，将文件夹复制到 Obsidian 插件目录（.obsidian/plugins/better-image-helper/）
3. 在 Obsidian 设置中启用插件

🔧 配置

首次使用时，需要配置阿里云 OCR API 的访问凭证：

1. 在插件设置中填写阿里云 AccessKey 和 AccessSecret

   AccessKey: 您的阿里云AccessKey
   AccessSecret: 您的阿里云AccessSecret
   

2. 或者在 Obsidian 库根目录下的 .env 文件中设置：

   ALI_AK=您的阿里云AccessKey
   ALI_SK=您的阿里云AccessSecret
   

🚀 使用方法

1. 识别图片文字：

   • 在 Obsidian 中右键点击任意图片
   • 选择 "OCR 识别图片文字" 菜单项
   • 等待识别完成，结果会显示在弹出窗口中

2. 结果操作：

   • 直接编辑识别文本（自动显示字符数和词数）
   • 点击"复制文本"将当前编辑的文本复制到剪贴板
   • 点击"创建为新笔记"将结果保存为独立的笔记文件
   • 点击窗口上方的路径右侧复制按钮可复制图片路径
   • 点击图片预览可在新窗口查看原图

💡 使用技巧

• 在源码模式下，将光标放在图片 Markdown 语法上（如 ![](image.png)）即可使用右键菜单
• 识别长篇文本时，可自由调整文本区域大小
• 识别网络图片时，需确保图片 URL 可直接访问

🌟 支持的图片来源

• Obsidian 库中的本地图片文件
• 附件文件夹中的图片
• 网络图片（HTTP/HTTPS URL）
• 剪贴板粘贴的图片（通过 Markdown 链接）

⚠️ 注意事项

• 使用前需要设置阿里云 OCR API 的 AccessKey 和 Secret
• 本插件需要联网使用，识别速度受网络状况影响
• 阿里云 OCR API 可能有使用限制和收费标准，请参考阿里云官方文档
• 如在使用过程中遇到问题，请查看控制台日志或提交 issue

📝 更新日志

1.0.4 (2024-04-15)

• 正式发布到Obsidian官方插件库
• 优化构建流程
• 修复了一些问题

0.1.0 (2023-04-15)

• 新增更美观的 OCR 结果展示窗口
• 添加实时字符统计功能
• 支持图片预览和路径复制
• 改进 UI/UX 设计，优化用户体验

0.0.1 (2023-04-15)

• 首次发布
• 支持多种模式下的图片 OCR 识别
• 基础结果展示和复制功能

💻 开发者说明

自动化版本发布流程

本项目设置了便捷的自动化版本发布流程，遵循语义化版本规范：

1. 版本脚本配置： 我们在package.json中添加了以下脚本:

   {
     "scripts": {
       "release:patch": "pnpm version patch && npm run release:post",
       "release:minor": "pnpm version minor && npm run release:post",
       "release:major": "pnpm version major && npm run release:post",
       "release:post": "git push && git push origin $(git describe --tags --abbrev=0)"
     }
   }
   

2. 一键发布命令：

   • 发布补丁版本 (例如 1.0.4 → 1.0.5): pnpm run release:patch
   • 发布次要版本 (例如 1.0.4 → 1.1.0): pnpm run release:minor
   • 发布主要版本 (例如 1.0.4 → 2.0.0): pnpm run release:major

3. 自动同步的文件： 当运行上述命令时，以下文件会自动更新版本号：

   • package.json：通过pnpm自动更新
   • manifest.json：通过version-bump.mjs脚本更新
   • versions.json：通过version-bump.mjs脚本更新

4. 工作原理：

   • 当执行版本更新命令时，pnpm version会更新package.json并创建git commit和tag
   • 然后触发version脚本运行version-bump.mjs
   • 该脚本自动更新manifest.json和versions.json中的版本信息
   • 最后，所有更改和新标签被推送到GitHub，触发GitHub Actions工作流
   • GitHub Actions自动构建项目并创建新的发布版本

5. 好处：

   • 减少手动错误，确保所有文件版本一致
   • 自动创建标签和发布，简化发布流程
   • 遵循语义化版本规范，保持版本管理的一致性

发布插件到Obsidian官方市场

如果你想参与贡献或者了解如何将此类插件发布到Obsidian官方市场，以下是完整流程：

1. 准备必要文件：

   • manifest.json：插件的基本信息，确保版本号遵循语义化版本规范
   • main.js：编译后的插件主文件
   • styles.css（可选）：如果插件有自定义样式
   • README.md：插件说明文档
   • LICENSE：开源许可证文件（如MIT）

2. 设置GitHub仓库：

   • 确保代码托管在GitHub上
   • 设置适当的.gitignore，排除node_modules和构建产物

3. 配置GitHub Actions自动发布：

   name: Release Obsidian plugin
   
   on:
     push:
       tags: ["*"]
   
   permissions:
     contents: write
   
   jobs:
     build:
       runs-on: ubuntu-latest
       steps:
         - uses: actions/checkout@v3
         - uses: actions/setup-node@v3
           with:
             node-version: "18.x"
         - uses: pnpm/action-setup@v2
           with:
             version: 8
         - name: Install dependencies
           run: pnpm install
         - name: Build plugin
           run: pnpm run build
         - name: Create release
           env:
             GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           run: |
             tag="${GITHUB_REF#refs/tags/}"
             gh release create "$tag" \
               --title "$tag" \
               --notes "Release $tag of the plugin." \
               dist/main.js dist/manifest.json
   

4. 创建发布版本：

   • 确保manifest.json中的版本号与GitHub标签一致
   • 推送一个与版本号相同的标签，如git tag -a 1.0.4 -m "Release 1.0.4"和git push origin 1.0.4
   • GitHub Actions将自动构建并创建发布版本

5. 提交到Obsidian官方插件库：

   • Fork obsidian-releases 仓库
   • 在community-plugins.json文件末尾添加插件信息：

     {
       "id": "better-image-helper",
       "name": "Image OCR",
       "author": "markshawn2020",
       "description": "Better image helper with OCR (via Alibaba Cloud API), future support for rotation, scaling, and other image operations, providing best user experience",
       "repo": "MarkShawn2020/obsidian-plugin-image-ocr"
     }
     

   • 创建PR，标题格式为"Add plugin: Image OCR"
   • 完成PR模板中的所有检查项
   • 等待Obsidian团队审核

6. 插件获得批准后：

   • 在Obsidian论坛的Share & showcase版块宣布
   • 在Discord的#updates频道宣布（需要开发者角色）

📄 许可证

MIT