Obsidian-Float-Search 开源项目教程

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

Obsidian-Float-Search 项目的目录结构如下：

Obsidian-Float-Search/
├── .github/
│   └── workflows/
│       └── main.yml
├── src/
│   ├── main.ts
│   ├── styles.css
│   └── manifest.json
├── .gitignore
├── LICENSE
├── README.md
└── package.json

目录结构介绍

• .github/workflows/main.yml: GitHub Actions 的工作流配置文件，用于自动化构建和部署。
• src/: 源代码目录，包含项目的核心代码。
  • main.ts: 项目的主入口文件。
  • styles.css: 项目的样式文件。
  • manifest.json: Obsidian 插件的清单文件，包含插件的元数据。
• .gitignore: Git 忽略文件列表，指定哪些文件和目录不需要被版本控制。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档，通常包含项目的基本信息和使用指南。
• package.json: Node.js 项目的配置文件，包含项目的依赖和脚本。

2. 项目的启动文件介绍

项目的启动文件是 src/main.ts。这个文件是 Obsidian 插件的入口点，负责初始化和启动插件的主要功能。

启动文件内容概览

import { Plugin } from 'obsidian';
import './styles.css';

export default class FloatSearchPlugin extends Plugin {
    async onload() {
        console.log('Float Search 插件已加载');
        // 插件初始化代码
    }

    onunload() {
        console.log('Float Search 插件已卸载');
    }
}

启动文件功能

• 导入依赖: 导入 Obsidian 的 Plugin 类和样式文件。
• 定义插件类: 定义 FloatSearchPlugin 类，继承自 Plugin。
• 初始化方法: onload 方法在插件加载时调用，执行插件的初始化逻辑。
• 卸载方法: onunload 方法在插件卸载时调用，执行清理逻辑。

3. 项目的配置文件介绍

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

manifest.json

manifest.json 是 Obsidian 插件的清单文件，包含插件的基本信息和配置。

{
    "id": "obsidian-float-search",
    "name": "Float Search",
    "version": "1.0.0",
    "minAppVersion": "0.12.0",
    "description": "在 Obsidian 中提供浮动搜索框",
    "author": "Quorafind",
    "authorUrl": "https://github.com/Quorafind",
    "isDesktopOnly": false
}

配置文件字段介绍

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

package.json

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

{
    "name": "obsidian-float-search",
    "version": "1.0.0",
    "description": "在 Obsidian 中提供浮动搜索框",
    "main": "src/main.ts",
    "scripts": {
        "dev": "rollup --config rollup.config.js --watch",
        "build": "rollup --config rollup.config.js"
    },
    "keywords": [
        "obsidian",
        "plugin",
        "search"
    ],
    "author": "Quorafind",
    "license": "MIT",
    "dev