【亲测免费】 Obsidian Kindle 插件使用教程

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

Obsidian Kindle 插件的目录结构如下：

obsidian-kindle-plugin/
├── .github/
│   └── workflows/
│       └── main.yml
├── .obsidian/
│   └── plugins/
│       └── obsidian-kindle-plugin/
├── assets/
│   └── icon.png
├── src/
│   ├── main.ts
│   ├── styles.css
│   └── manifest.json
├── .gitignore
├── .npmrc
├── LICENSE
├── package.json
├── README.md
└── tsconfig.json

目录结构介绍

• .github/workflows/main.yml: GitHub Actions 的工作流配置文件，用于自动化构建和发布。
• .obsidian/plugins/obsidian-kindle-plugin/: Obsidian 插件的存储目录。
• assets/icon.png: 插件的图标文件。
• src/: 源代码目录，包含插件的主要逻辑和样式文件。
  • main.ts: 插件的主入口文件。
  • styles.css: 插件的样式文件。
  • manifest.json: 插件的清单文件，包含插件的基本信息和配置。
• .gitignore: Git 忽略文件列表。
• .npmrc: npm 配置文件。
• LICENSE: 插件的许可证文件。
• package.json: 项目的 npm 配置文件，包含依赖和脚本。
• README.md: 项目的说明文档。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/main.ts。这个文件是插件的入口点，负责初始化插件并注册各种事件和命令。

主要功能

• 初始化插件实例。
• 注册 Obsidian 命令，使用户可以通过命令面板或快捷键触发插件功能。
• 监听 Obsidian 事件，如笔记的创建、修改和删除等。

3. 项目的配置文件介绍

项目的配置文件是 src/manifest.json。这个文件包含了插件的基本信息和配置选项。

主要内容

• id: 插件的唯一标识符。
• name: 插件的名称。
• version: 插件的版本号。
• minAppVersion: 插件支持的最低 Obsidian 版本。
• description: 插件的描述信息。
• author: 插件的作者信息。
• isDesktopOnly: 是否仅支持桌面版 Obsidian。

通过这些配置，Obsidian 可以正确加载和运行插件，并提供相应的功能。