三股水
Obsidian 插件二次开发:零基础也能轻松上手的小技巧

二开了 Obsidian 的 Typecho 插件之后,简直像是发现了一片新大陆——原来 Obsidian 还能这么玩!以前总觉得要懂技术才能折腾插件,现在有了 AI 的辅助,技术门槛真的被拉低了不少,尤其是在 Obsidian 插件二开这件事上,过程比想象中要简单太多。

当然啦,虽然门槛低了,但里面还是有一些实用的小技巧值得掌握的。这几天我从零开始摸索,踩了不少坑,也浪费了不少冤枉时间。今天就把这些基础经验整理出来,分享给大家。我本身也不懂技术,全靠 AI 帮忙,太深奥的我也不会,但只要你掌握了下面这几个小技巧,就能轻松地让 AI 辅助你完成 Obsidian 插件的二次开发。


1. 找对源代码:别直接改插件目录里的文件

很多人一开始会下意识地跑到 Obsidian 仓库里的 .obsidian/plugins/ 目录去找插件代码,觉得那里就是插件的“家”。没错,插件确实在那,但你看到的其实是经过打包和压缩后的代码,并不是作者原本写的源代码。

这种打包后的代码:

  • 几乎没有可读性
  • 变量名被简化、函数被合并
  • 很长很乱,即使让编辑器或 AI 帮忙格式化,依然难以理解
  • 有些甚至根本无法正常格式化

我一开始就吃了这个亏,花了好多时间在那堆“天书”一样的代码里挣扎,改一行代码要找半天,改完了还动不动就报错。

直到后来我才搞清楚一个常识:绝大多数 Obsidian 插件都是基于 GitHub 开源的。你只要在插件市场的插件介绍页面里翻一翻,几乎都能找到 GitHub 仓库地址。从那里下载下来的,才是作者原汁原味的源代码——多文件、结构清晰、注释完整,阅读和修改起来都非常舒服。

小技巧:去 GitHub 上找插件仓库,找到 main.tssrc 目录,那才是二开的正确起点。


2. 会编辑代码:别用记事本,选对工具

有了源代码之后,接下来就要选择一个合适的代码编辑器。千万不要用系统自带的记事本或者 WPS 去改代码,那会让你怀疑人生。

推荐使用 VS Code(Visual Studio Code),免费、强大、对 TypeScript / JavaScript 支持极好。用它打开插件源码目录,语法高亮、代码跳转、错误提示都很友好,对新手来说体验提升很大。

小技巧:在 VS Code 里打开整个插件源码文件夹,比单独打开文件更方便,AI 辅助时也更容易理解上下文。


3. 会封装代码:别怕 npm,交给 AI 就好

代码修改好之后,怎么把它变成 Obsidian 能识别的插件文件(比如 main.js)呢?这就涉及到一个叫做“打包”或“构建”的过程。

刚开始接触 npm 的时候我也一头雾水,各种命令行、依赖安装、打包脚本……看起来很吓人。但别慌,把这些全部丢给 AI 就行。你只要告诉 AI:

“我修改了一个 Obsidian 插件的源码,如何用 npm 打包生成新的 main.js?”

AI 会一步一步教你安装 Node.js、运行 npm install、执行打包命令(通常是 npm run buildnpm run dev)。你只需要照做,一行命令,就能生成你在插件目录里看到的那种打包后的文件。

小技巧:打包成功后,你会得到一个 main.js 文件(有时还有 manifest.json),这才是 Obsidian 真正运行的插件文件。


4. 会安装使用:替换文件 + 禁用启用

生成新的 main.js 文件后,操作就非常简单了:

  1. 把它复制到你 Obsidian 仓库的 .obsidian/plugins/插件名/ 目录下,覆盖原有的 main.js
  2. 然后回到 Obsidian 的设置 → 第三方插件 → 找到这个插件
  3. 先禁用,再重新启用

这一步非常关键,因为 Obsidian 会缓存插件,只覆盖文件不重载的话,二开的效果不会生效。

小技巧:如果禁用再启用后没有变化,可以试试完全重启 Obsidian,或者按 Ctrl + Shift + R 强制刷新。


5. 一点最后的提醒

千万不要在 Obsidian 里点击“更新插件”,哪怕插件作者发布了新版本。一旦更新,你二开的所有改动都会被官方文件覆盖掉,一切努力就白费了。

如果想长期使用自己的版本,可以:

  • 给插件改一个本地版本号(比如在 manifest.json 里把 0.1.0 改成 0.1.0-custom
  • 或者干脆断开该插件的更新提醒

总结

AI 让技术不再是障碍,但找到正确的源代码、用对工具、学会简单打包、正确安装使用,这四个小技巧才是你顺利二开 Obsidian 插件的关键。希望我的踩坑经验,能帮你省下几天冤枉时间,早日玩转属于自己的插件~

这是一次尝试,本文由我写的框架,AI按我的思路填充的完整内容,且让AI给我生成markdown格式,复制粘贴成文发布,OB+TY,简直绝配了。

😊
提交

评论区

共 4 条评论

  1. 头像
    我记得Obsidian可以直接发布当网站吧
    6月12日 河南
    1. 头像
      XIGE 博主
      @网友小宋 可以我前面就发文了哈,我还优化了现有的唯一的obsidian发布到typecho插件,现在已经适配得非常好了,网站和obsidian文章实时同步,还有版本控制。两边都可以发布,自动同步另一边,修改也是。
      6月12日 云南
  2. 头像
    水拍石 Lv1
    厉害了,这和静态博客的流程一样了,你双向同步,不担心云端故障后把本地给清空了吗?我觉得还是单向同步比较安全。
    6月12日 陕西
    1. 头像
      XIGE 博主
      @水拍石 不会,带版本控制的,相互传会自动成个新的版本,不会覆盖
      6月12日 云南