SuperAPI AI 工具集

obsidian-hello-world

编程与开发

查看项目

更新于 10-15 23:27

技能介绍

用途:构建一个最小可运行的 Obsidian 插件,演示五类核心构建块:命令(命令面板、编辑器命令、checkCallback)、带类型配置的设置页、功能区图标、模态框和状态栏,所有代码片段均使用真实 Obsidian API。

主要能力:提供三种命令类型(callback 始终可用、editorCallback 仅在编辑器激活时可用、checkCallback 按上下文条件显示);设置页含文本、开关和下拉控件;功能区图标点击处理;带交互按钮的模态框;显示实时字数的状态栏;以及 file-open、create 等事件监听。

使用方式:需先完成 obsidian-install-auth 环境准备(已符号链接开发库、npm run dev 可用),并有从 src/main.ts 生成 main.js 的构建流程。按步骤定义类型化设置、编写插件类与命令、创建设置页与模态框,然后执行 npm run build,在 Obsidian 中启用插件并测试各命令。

适用场景:开发首个插件功能、验证开发环境、学习 Obsidian 插件基本结构。

限制:资料未提供收费、价格、平台支持范围等信息;部分细节(如热重载、生产级防抖)需参考后续文档。