Logseq-Omnivore 插件安装与使用指南

Logseq-Omnivore 插件安装与使用指南

logseq-omnivore Logseq plugin to fetch articles and highlights from Omnivore 项目地址: https://gitcode.com/gh_mirrors/lo/logseq-omnivore

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

logseq-omnivore/
├── src/
│   ├── main.ts
│   ├── utils.ts
│   └── ...
├── public/
│   ├── index.html
│   └── ...
├── config/
│   ├── default.json
│   └── ...
├── package.json
├── README.md
└── ...

目录结构介绍

• src/: 包含插件的主要源代码文件，如 main.ts 和 utils.ts。
• public/: 包含插件的静态资源文件，如 index.html。
• config/: 包含插件的配置文件，如 default.json。
• package.json: 项目的依赖管理文件，定义了项目的依赖和脚本。
• README.md: 项目的说明文档，包含项目的介绍、安装和使用方法。

2. 项目的启动文件介绍

src/main.ts

main.ts 是插件的入口文件，负责初始化插件并启动相关服务。以下是 main.ts 的主要功能：

• 初始化插件: 加载插件的配置文件并初始化插件。
• 启动服务: 启动与 Omnivore 的同步服务，定期从 Omnivore 获取文章和亮点。
• 事件监听: 监听 Logseq 的事件，如页面加载、保存等，以便及时更新数据。

3. 项目的配置文件介绍

config/default.json

default.json 是插件的默认配置文件，包含插件的基本配置信息。以下是 default.json 的主要配置项：

• apiKey: Omnivore 的 API 密钥，用于与 Omnivore 进行数据同步。
• syncFrequency: 数据同步的频率，单位为分钟。
• pageName: 同步到 Logseq 的页面名称，可以是 [[title]] 或 [[date]]。
• isSinglePage: 是否将所有文章同步到一个页面，默认为 true。

配置示例

{
  "apiKey": "your-api-key",
  "syncFrequency": 60,
  "pageName": "[[[title]]]",
  "isSinglePage": true
}

总结

通过以上介绍，您可以了解 Logseq-Omnivore 插件的目录结构、启动文件和配置文件。希望这份指南能帮助您顺利安装和使用该插件。

logseq-omnivore Logseq plugin to fetch articles and highlights from Omnivore 项目地址: https://gitcode.com/gh_mirrors/lo/logseq-omnivore