用途:为 Obsidian 插件开发搭建完整环境,从克隆官方示例插件到在 Obsidian 中验证插件加载。
前置条件:Node.js 18+(建议 LTS)、npm 或 pnpm、已安装 Obsidian 桌面端(https://obsidian.md)、Git。
主要能力与步骤:
- 克隆官方模板:git clone https://github.com/obsidianmd/obsidian-sample-plugin.git my-obsidian-plugin,重置 Git 历史。模板含 esbuild.config.mjs、tsconfig.json、manifest.json、src/main.ts。
- 安装依赖:npm install,安装 obsidian(仅类型定义)、typescript、esbuild、@types/node、tslib。
- 配置 manifest.json:必填 id、name、version、minAppVersion、description、author;id 须为小写 kebab-case 并与插件文件夹名一致;minAppVersion 建议 1.5.0 以上。
- 创建 versions.json,将插件版本映射到最低 Obsidian 版本。
- 创建开发库 ~/ObsidianDev,含 .obsidian/plugins 与测试笔记。
- 符号链接:ln -sfn "$PLUGIN_DIR" "$DEV_VAULT/.obsidian/plugins/$PLUGIN_ID";Windows 用 mklink /D。
- 构建验证:npm run build(生产)与 npm run dev(监听模式);在 Obsidian 设置中启用社区插件并开启插件,用 Ctrl+Shift+I 查看控制台,Ctrl+R 重载。
- 可用最小 main.ts 验证 Vault API 与命令注册是否生效。
适用场景:开始新插件项目、配置开发环境、调试插件加载。
限制与注意:需 Node.js 18+;Windows 符号链接需管理员权限;热重载需安装 Hot Reload 插件或手动 Ctrl+R;严格空值检查可能导致编译错误,需加空值守卫;资料未提供收费、平台兼容性或效果数据。