Obsidian Alfred 插件使用教程

Obsidian Alfred 插件使用教程

obsidian-alfredAlfred workflow for Obsidian note-taking app. Open vaults and files in Obsidian.项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-alfred

项目目录结构及介绍

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

obsidian-alfred/
├── README.md
├── alfredworkflow
├── config.json
├── main.py
└── requirements.txt

• README.md: 项目说明文档，包含项目的基本信息和使用指南。
• alfredworkflow: Alfred 工作流程文件，可以直接导入到 Alfred 中使用。
• config.json: 配置文件，用于存储插件的配置信息。
• main.py: 项目的启动文件，包含主要的逻辑代码。
• requirements.txt: 依赖文件，列出了项目运行所需的 Python 包。

项目的启动文件介绍

main.py 是项目的启动文件，主要负责处理 Alfred 的输入并调用相应的功能模块。以下是 main.py 的主要内容：

import sys
import json
from obsidian import Obsidian

def main():
    query = sys.argv[1]
    obsidian = Obsidian()
    results = obsidian.search(query)
    print(json.dumps(results))

if __name__ == "__main__":
    main()

• import sys: 导入系统模块，用于获取命令行参数。
• import json: 导入 JSON 模块，用于处理 JSON 数据。
• from obsidian import Obsidian: 从 obsidian 模块中导入 Obsidian 类。
• def main(): 定义主函数，处理 Alfred 的输入并调用 Obsidian 类的 search 方法。
• if __name__ == "__main__":: 判断是否为主程序入口，如果是则调用 main 函数。

项目的配置文件介绍

config.json 是项目的配置文件，用于存储插件的配置信息。以下是一个示例配置文件的内容：

{
    "vault_path": "/path/to/your/obsidian/vault",
    "default_query": "default search query"
}

• vault_path: Obsidian 库的路径，插件将在此路径下进行搜索。
• default_query: 默认搜索查询，当用户没有输入查询时，将使用此默认查询。

通过修改 config.json 文件，可以自定义插件的行为，例如更改 Obsidian 库的路径或设置默认搜索查询。

obsidian-alfredAlfred workflow for Obsidian note-taking app. Open vaults and files in Obsidian.项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-alfred