Obsidian 插件开发文档

Obsidian 插件开发文档

文档地址 open in new window 文档 Github 地址 open in new window

文档更新说明 📢

官方文档近期更新变动较大,目录结构也进行了调整,我会尽快对文档进行整理翻译,并更新2.0版本。敬请期待~

关于共建

本文翻译自 这篇文档open in new window

由于本人水平以及精力有限,如果有翻译不周到之处还望海涵,方便的话可以提 Issueopen in new window 以便让我修正~

有愿意加入的小伙伴欢迎提PR~

Obsidianopen in new window 社区的 @the_three 小伙伴提出了一些观点跟建议open in new window,具体如下:

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

相信这些是很多 Obsidian 插件开发者小伙伴都会遇到的问题。为此,如果有看到此文档的小伙伴,欢迎加入文档共建!有疑问,有新的发现,亦或是有对文档的补充与纠正,欢迎在 issue 区留言,我会定期整理并更新到文档中。希望可以借此帮助到更多开发小伙伴~

感谢诸位~ 🫶