首页
/ Obsidian Tray 插件使用教程

Obsidian Tray 插件使用教程

2024-08-31 18:24:50作者:江焘钦

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

Obsidian Tray 插件的目录结构如下:

obsidian-tray/
├── LICENSE
├── README.md
├── main.js
├── manifest.json
├── obsidian.png
└── tray.png
  • LICENSE: 项目的许可证文件,采用 MIT 许可证。
  • README.md: 项目的说明文档,包含插件的基本信息和使用方法。
  • main.js: 插件的主逻辑文件,负责启动和管理 Obsidian 应用。
  • manifest.json: 插件的配置文件,包含插件的元数据和依赖信息。
  • obsidian.png: Obsidian 应用的图标文件。
  • tray.png: 系统托盘图标文件。

2. 项目的启动文件介绍

main.js 是 Obsidian Tray 插件的启动文件,主要负责以下功能:

  • 在系统启动时自动打开 Obsidian 应用。
  • 添加全局快捷键,用于切换窗口可见性和创建快速笔记。
  • 提供系统托盘菜单,用于管理 Obsidian 应用的窗口和功能。

3. 项目的配置文件介绍

manifest.json 是 Obsidian Tray 插件的配置文件,包含以下关键配置项:

{
  "id": "obsidian-tray",
  "name": "Tray",
  "version": "1.0.0",
  "minAppVersion": "0.12.0",
  "description": "Run Obsidian from the system tray for customizable window management & global quick notes",
  "author": "dragonwocky",
  "authorUrl": "https://github.com/dragonwocky",
  "isDesktopOnly": true
}
  • id: 插件的唯一标识符。
  • name: 插件的名称。
  • version: 插件的版本号。
  • minAppVersion: 插件支持的最低 Obsidian 应用版本。
  • description: 插件的描述信息。
  • author: 插件的作者。
  • authorUrl: 作者的 GitHub 主页。
  • isDesktopOnly: 是否仅支持桌面端。

通过以上配置,用户可以了解插件的基本信息和兼容性要求,确保正确安装和使用插件。

登录后查看全文
热门项目推荐