https://github.com/luhaifeng666/obsidian-plugin-docs-zh

Obsidian 插件开发文档
https://github.com/luhaifeng666/obsidian-plugin-docs-zh

Last synced: 2 months ago
JSON representation

Obsidian 插件开发文档

• Host: GitHub
• URL: https://github.com/luhaifeng666/obsidian-plugin-docs-zh
• Owner: luhaifeng666
• Archived: true
• Created: 2022-03-28T09:05:43.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-08-21T09:03:47.000Z (over 1 year ago)
• Last Synced: 2024-08-01T20:48:52.833Z (5 months ago)
• Language: JavaScript
• Homepage: https://luhaifeng666.github.io/obsidian-plugin-docs-zh/
• Size: 92.2 MB
• Stars: 64
• Watchers: 2
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • Security: SECURITY.md

Awesome Lists containing this project

• my-awesome - luhaifeng666/obsidian-plugin-docs-zh - 08 star:0.1k fork:0.0k Obsidian 插件开发文档 (JavaScript)

README

        







Obsidian 插件开发文档











> 重要提醒！！

>

> 该文档的原文档现已不再维护，官方文档已经迁移至 [`新地址`](https://docs.obsidian.md/Home)。本文档目前尚可作参考，如若发现有不对劲的地儿，可移步至官方文档进行查阅~

>

> 官方的 Github 地址[`请戳这里`~](https://github.com/obsidianmd/obsidian-developer-docs)!

>

> 感谢诸位这段时间的使用与支持~

关于共建




本文翻译自 [这篇文档](https://marcus.se.net/obsidian-plugin-docs) 。

由于本人水平以及精力有限，如果有翻译不周到之处还望海涵，方便的话可以提 [Issue](https://github.com/luhaifeng666/obsidian-plugin-docs-zh/issues) 以便让我修正~

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

[Obsidian](https://forum-zh.obsidian.md/) 社区的 @the_three 小伙伴提出了一些[观点跟建议](https://forum-zh.obsidian.md/t/topic/7824/2?u=酱豆腐精)，具体如下：



> 1. 官方文档里面很多函数或类都没有说是干什么用的，连个注释也没有。开发的时候想用到某种功能，即使文档里有，也找不到。

> 2. 很多方法API文档里面不收录，可能作者还没想发布出来，但是实际上已经有很多插件开发者自己找到在用着了。有很多方法都只有去读其他插件的源码才能知道。

> 3. 现在流传比较广的ob开发文档都是针对初学者的，内容比较初级，到了实际开发的时候会需要很多复杂的功能，针对这些功能的文档还没有看到。



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

感谢诸位~ 🫶