Obsidian 插件开发
从模板起手搭建 Obsidian 插件工程,写命令、设置面板与弹窗,跑构建和 lint,最后按清单发布到 GitHub。
功能与用途
想给自己的笔记流程做个插件,但从哪起手、manifest 怎么填、怎么进调试环境都不清楚。这个 Skill 以 sample-plugin-plus 模板为基础,走完克隆模板、改 manifest/package.json/README、初始化开发环境、清掉样板代码、写进命令与设置面板、装进仓库里测试的整条路径,还给出发布前的检查清单(版本号、versions.json、构建与 lint 零错误、GitHub Release 里该传哪几个文件)。
适用场景
- 新插件工程脚手架搭建:使用 sample-plugin-plus 模板快速初始化仓库,配置 manifest 与依赖并清理示例样板代码。
- 核心交互功能开发:按规范编写自定义命令、侧边栏缎带图标、弹窗交互以及设置面板,操作笔记与编辑器。
- 本地调试与构建发布:软链接插件到测试仓库并配合热重载调试,完成代码规范检查与打包,输出标准发布产物。
适用人群
- 给 Obsidian 写社区插件的 TypeScript 开发者
- 需要定制内部笔记插件、想跑通发布流程的工程师
- 拿模板学 Obsidian API 的前端开发者
使用步骤
- 用模板创建插件仓库,或直接克隆 sample-plugin-plus 后清掉 .git 重新初始化。
- 改 manifest.json、package.json 和 README,把 id、名字、作者、最低 Obsidian 版本填成自己的。
- 装依赖并初始化开发环境,然后清理 src/main.ts 里的示例代码、把类名改成自己的。
- 用 watch 模式开发,把构建产物拷进仓库的插件目录或做软链,在 Obsidian 里启用插件实测。
- 按发布清单核对版本号与 versions.json,构建和 lint 都干净后传 GitHub Release。
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 编程
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes、国内 Agent
- 使用难度
- 专业
- 版本
- 1.0.0
- 最近更新
- 2026-05-11
- 文件数
- 3
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过
Create and develop Obsidian plugins from scratch. Use when building a new Obsidian plugin, scaffolding from the sample-plugin-plus template, or developing plugin features. Covers project setup, manifest configuration, TypeScript development, settings UI, commands, ribbons, modals, and Obsidian API patterns.
使用前准备
- 需要 Node 与 pnpm 环境、Git 与 GitHub 账号(gh CLI 可选),并本地装有 Obsidian 用于加载调试
- 假定已懂 TypeScript 与 Obsidian API。
依赖与权限
- 读取用户主动提供的内容