Obsidian-Omnivore 插件使用教程

Obsidian-Omnivore 插件使用教程

obsidian-omnivoreObsidian plugin to fetch articles and highlights from Omnivore项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-omnivore

1. 项目的目录结构及介绍

Obsidian-Omnivore 插件的目录结构如下：

obsidian-omnivore/
├── src/
│   ├── main.ts
│   ├── styles.css
│   └── ...
├── .editorconfig
├── .eslintignore
├── .eslintrc
├── .gitignore
├── .prettierrc
├── CHANGELOG.md
├── LICENSE.md
├── README.md
├── esbuild.config.mjs
├── jest.config.js
├── manifest.json
├── package.json
├── release.config.js
├── styles.css
├── tsconfig.json
├── version-bump.mjs
├── versions.json
└── yarn.lock

目录结构介绍

• src/: 包含插件的主要源代码文件。
  • main.ts: 插件的入口文件。
  • styles.css: 插件的样式文件。
• .editorconfig, .eslintignore, .eslintrc, .gitignore, .prettierrc: 代码格式和风格配置文件。
• CHANGELOG.md, LICENSE.md, README.md: 项目文档文件。
• esbuild.config.mjs, jest.config.js: 构建和测试配置文件。
• manifest.json: 插件的元数据文件。
• package.json: 项目的依赖和脚本配置文件。
• release.config.js: 发布配置文件。
• tsconfig.json: TypeScript 配置文件。
• version-bump.mjs, versions.json: 版本管理相关文件。
• yarn.lock: 依赖锁定文件。

2. 项目的启动文件介绍

入口文件

src/main.ts 是 Obsidian-Omnivore 插件的入口文件。它负责初始化插件并定义插件的主要功能。

主要功能

• 初始化插件实例。
• 注册插件命令。
• 处理数据同步逻辑。

3. 项目的配置文件介绍

manifest.json

manifest.json 是 Obsidian 插件的元数据文件，包含插件的基本信息和版本信息。

{
  "id": "obsidian-omnivore",
  "name": "Omnivore",
  "version": "1.0.0",
  "minAppVersion": "0.12.0",
  "description": "Obsidian plugin to fetch articles and highlights from Omnivore",
  "author": "Omnivore",
  "authorUrl": "https://omnivore.app",
  "isDesktopOnly": false
}

package.json

package.json 是 Node.js 项目的配置文件，包含项目的依赖、脚本和其他配置信息。

{
  "name": "obsidian-omnivore",
  "version": "1.0.0",
  "description": "Obsidian plugin to fetch articles and highlights from Omnivore",
  "main": "main.js",
  "scripts": {
    "dev": "node esbuild.config.mjs",
    "build": "node esbuild.config.mjs production",
    "version": "node version-bump.mjs && git add versions.json"
  },
  "keywords": [
    "obsidian",
    "obsidian-plugin"
  ],
  "author": "Omnivore",
  "license": "MIT",
  "devDependencies": {
    ...
  },
  "dependencies": {
    ...
  }
}

其他配置文件

• .editorconfig, .eslintignore, .eslintrc, .prettierrc: 代码格式和风格配置文件。
• tsconfig.json: TypeScript 配置文件。
• esbuild.config.mjs: 构建配置文件。
• jest.config.js: 测试配置文件。
• release.config.js: 发布配置文件。

以上是 Obsidian-Omnivore 插件的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！<｜end▁of▁sentence｜>

obsidian-omnivoreObsidian plugin to fetch articles and highlights from Omnivore项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-omnivore