Obsidian 插件开发文档

网上关于 Obsidian 的插件开发文档较少,官方的 github 下收录了社区整理的插件开发文档,这个文档有线上版本,地址是这个: Obsidian Plugin Developer Docs | Obsidian Plugin Developer Docs
为了方便,本人将此文档翻译了下,有需要的大佬可以参考这个地址:Obsidian 插件开发文档
因为本人水平有限,有翻译不到位的地方还请反馈给我,以便我及时修正。如果你觉得文档对你有帮助,欢迎star~感谢~

7 个赞

感谢翻译!

我觉得现在ob的插件开发文档还有这样一些问题:

  • 官方文档里面很多函数或类都没有说是干什么用的,连个注释也没有。开发的时候想用到某种功能,即使文档里有,也找不到。
  • 很多方法API文档里面不收录,可能作者还没想发布出来,但是实际上已经有很多插件开发者自己找到在用着了。有很多方法都只有去读其他插件的源码才能知道。
  • 现在流传比较广的ob开发文档都是针对初学者的,内容比较初级,到了实际开发的时候会需要很多复杂的功能,针对这些功能的文档还没有看到。

我觉得可以在这个文档后面,或者新开一个文档,专门收录现在各个开发者掌握的功能或设计方法,积少成多。无论是新手还是老手都有收获。

1 个赞

确实!我在用的过程中也发现了,有些方法文档里没有,还是自己跳去看 Typescript 的定义看到的。
我觉得你说的很有道理!我觉得可以通过 issue 的形式,如果有发现没有提到的方法的话,可以提issue,让大家在下面讨论跟补充。然后我再统一收录补充。

感谢反馈~ 欢迎加入共建~

文档已经添加评论模块,如果文档中有问题,或者对文档有补充的,也可以在评论区中讨论~