思源笔记插件开发完全指南5步做出属于自己的定制功能【免费下载链接】siyuanAn open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间让人与智能体在此协作项目地址: https://gitcode.com/GitHub_Trending/si/siyuan思源笔记siyuan是一个开源、隐私优先、可自托管的知识工作空间支持人与 AI 智能体协作。它的标准功能已经很完整但总有差一点点的时刻——这篇指南讲的就是思源笔记插件开发从跑通环境到发布集市5 步做出能落地的定制功能。为什么值得自己写一个插件先问三个问题中两个就适合动手你想要的功能官方版本里没有也不想等排期你经常重复同一段操作希望一键完成你想把外部服务翻译、导出、自动化接进笔记里插件的意义就是把差一点点补上。思源笔记的插件能力分两层别搞混前端插件跑在浏览器环境里操作界面、编辑器、菜单代码在 app/src/plugin/内核插件跑在 Go 内核里能监听文件、注册 RPC 接口代码在 kernel/plugin/新手建议从前端插件起步门槛低、见效快。3 条命令搭好思源笔记开发环境别急着写代码先把项目跑起来。确认你机器上有 Node.js 和 pnpm然后git clone https://gitcode.com/GitHub_Trending/si/siyuan cd siyuan/app pnpm install安装完依赖后执行pnpm run dev编译前端资源再用pnpm start启动 Electron 桌面端。如果编译报字体或二进制依赖错误试试网络代理或镜像源这类问题九成出在下载资源阶段别怀疑自己的代码。插件API入口在哪看先收藏这 3 个地方开发前把资料定位好能省掉一半的翻源码时间官方 API 中文文档列出笔记本、文档、块、数据库、SQL、导出等全部接口每个接口都有参数和返回值说明是查接口的第一站WORKSPACE 工作空间文档讲数据目录结构。插件存放目录就是工作区下的data/plugins装插件、看日志都跟它有关前端插件 API 实现浏览器端能调用的方法都从这里注入想知道页面里到底能用什么直接读它比猜快每个插件绕不开的 4 组核心接口翻完 API 文档 目录你会发现接口很多但 90% 的插件只用得到下面这组块操作插入、更新、移动、折叠块——笔记里一切内容都是块改内容绕不开它SQL 查询思源把笔记内容索引成数据库一行 SQL 就能跨笔记取数做统计类插件全靠它模板渲染调用内置模板引擎生成文本适合做批量生成类功能系统通知推送消息/推送报错消息让用户知道插件在干什么写代码时按先查文档、再看 api_rpc.go 里的调用方式、最后写调用的顺序来基本不会走弯路。插件放哪、怎么调试新手卡住最多的两步插件开发的环境坑集中在这两点位置插件代码放进工作区的data/plugins/插件名/目录启动时内核会扫描该目录并加载。开发阶段改完文件重启一次应用即可内核插件还支持文件变更热重载见 manager.go调试前端插件打开开发者工具F12看控制台报错内核插件看应用日志。报错信息里的接口名直接拿去 API 文档搜就能定位参数问题插件跑通之后4 条进阶路线第一个插件跑起来只是开始接下来按兴趣挑方向自定义界面组件菜单、弹窗、顶栏按钮参考 app/src/menus/ 的写法接入 AI 能力仓库内置 AI 模块与 MCP 服务可让插件调用智能体处理笔记数据处理扩展用 SQL 属性视图数据库功能做笔记统计分析导出定制结合 Pandoc 转换接口kernel/api/pandoc.go生成自定义格式从自用工具到集市上架发布路径插件做好了分发靠官方集市Bazaar按 package.go 中的Package结构补齐元数据版本、显示名多语言、描述、图标把插件打成包提交到集市仓库审核通过后用户就能在应用内一键安装更新版本号即可推送升级minAppVersion字段用于声明兼容的最低应用版本上架前用干净工作区自测一遍安装、启动、卸载是避免差评最有效的方式。新手 FAQ3 个最常问的问题Q前端插件和内核插件必须都会吗不用。绝大多数需求前端就能解决只有需要监听文件系统、提供持久 RPC 服务时才写内核插件。Q不 clone 源码能开发插件吗可以。日常开发只需要 API 文档 一个运行中的思源笔记clone 源码主要是为了读实现和改内核。Q插件写崩了会损坏笔记吗不会。插件只读写data/plugins和自己的存储区笔记数据在工作区文档目录里两者隔离。把环境跑起来选一个小痛点5 步走完就是第一个插件——现在就可以打开终端敲下第一条命令 ✨【免费下载链接】siyuanAn open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间让人与智能体在此协作项目地址: https://gitcode.com/GitHub_Trending/si/siyuan创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考