Obsidian OCR 项目教程

Obsidian OCR 项目教程

obsidian-ocrObsidian OCR allows you to search for text in your images and pdfs项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-ocr

项目的目录结构及介绍

Obsidian OCR 项目的目录结构如下：

obsidian-ocr/
├── .github/
│   └── workflows/
├── src/
│   ├── main.ts
│   ├── styles.css
│   └── manifest.json
├── .gitignore
├── LICENSE
├── README.md
└── package.json

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• src/: 包含项目的源代码文件。
  • main.ts: 项目的入口文件。
  • styles.css: 项目的样式文件。
  • manifest.json: 项目的插件清单文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• package.json: 项目的依赖和脚本配置文件。

项目的启动文件介绍

项目的启动文件是 src/main.ts。这个文件是 Obsidian OCR 插件的入口点，负责初始化插件并注册必要的命令和事件监听器。

// src/main.ts
import { Plugin } from 'obsidian';
import { OCRProcessor } from './ocrProcessor';

export default class ObsidianOCRPlugin extends Plugin {
  async onload() {
    console.log('Obsidian OCR 插件已加载');
    this.addCommand({
      id: 'ocr-search',
      name: 'Search text in images and PDFs',
      callback: () => {
        new OCRProcessor(this.app).process();
      }
    });
  }

  onunload() {
    console.log('Obsidian OCR 插件已卸载');
  }
}

项目的配置文件介绍

项目的配置文件主要是 manifest.json 和 package.json。

manifest.json

manifest.json 文件定义了插件的基本信息和依赖项。

{
  "id": "obsidian-ocr",
  "name": "Obsidian OCR",
  "version": "1.1.0",
  "minAppVersion": "0.12.0",
  "description": "Allows you to search for text in your images and PDFs",
  "author": "MohrJonas",
  "authorUrl": "https://github.com/MohrJonas",
  "isDesktopOnly": false
}

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。

{
  "name": "obsidian-ocr",
  "version": "1.1.0",
  "description": "Allows you to search for text in your images and PDFs",
  "main": "src/main.ts",
  "scripts": {
    "build": "tsc -p ./",
    "dev": "npm run build && node esbuild.config.mjs"
  },
  "keywords": [
    "obsidian",
    "ocr",
    "plugin"
  ],
  "author": "MohrJonas",
  "license": "GPL-3.0",
  "devDependencies": {
    "obsidian": "^0.12.0",
    "typescript": "^4.5.2"
  }
}

以上是 Obsidian OCR 项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用这个开源项目。

obsidian-ocrObsidian OCR allows you to search for text in your images and pdfs项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-ocr