Obsidian 开发者文档Appearance
Obsidian 开发者中文文档
官方文档翻译的入口请看： Home
| Docs | Github Repo | |
|---|---|---|
| Raistlind翻译的开发者文档 (raistlind.github.io) | Raistlind/obsidian-dev-docs-zh | 1 year ago |
| luhuafeng666翻译的插件文档 | luhaifeng666/obsidian-plugin-docs-zh: Obsidian 插件开发文档 (github.com) | 2 years ago |
免责申明 Disclaim
译者免责声明
本文档不正式隶属于 Obsidian 团队，也未得到 Obsidian 团队的认可。
本 Fork 目前的维护者和原始项目的创建者目前也并无任何正式关系。
内容翻译自官方文档以及社区文档。译者的翻译也可能有错误，在开发中请自行决定是否查看英文原文或者寻求其他帮助。译者不对因为内容翻译准确性以及及时性导致的后果承担责任。
随着 Obsidian 的更新，请留意相关的API更改，以官方文档为准，在适当的时候更新代码。
如果涉及到版权相关内容，请联系我。
前言
本项目Fork From Raistlind/obsidian-dev-docs-zh。
由LIUBINfighter (Jay Bridge) (github.com)持续维护。
使用vitepress构建:
本 README 后面的网址都是可以参考的。我也会根据我自己开发的需要逐步翻译和添加自己的内容。
Obsidian开发一般指 Theme(主题) 和 Plugin(插件) 开发。这也会是本文档关注的主要内容。
希望能成为更新快，内容丰富的中文文档。对于不能及时更新的部分，提供充足的资源整合导航。
我会按照我的想法组织内容，可能和官方文档的方式存在出入。对于 Raistlind 和 luhuafeng666 两位前辈已翻译的部分，我不会进行删改，只会进行增量式的补充和链接引用。
写作规范 文档规范 - Obsidian 中文帮助 - Obsidian Publish
天哪我真的好爱写文档。
工作方式
我会在学习相关技术和源码的同时进行翻译和文档撰写工作。
官方文档翻译将会保持原来的结构（插件 主题 参考 三部分）。
社区文档和我的文章将会另外单列出来。同时会引用原来luhuafeng666翻译的插件文档的内容以及其他网络内容。
对于未能及时翻译的部分，请查看下面列出的网址。
官方文档和社区内容
网址主要有以下分类：
1.文档 2.文档Repo 3.开发Repo 4.资源聚合网站 5.论坛和新闻
为什么这么分类？如果是文档Repo的话意味着你可以本地进行RAG（我正在开发的一个插件的灵感），甚至很方便的加入 MCP 。
Obsidian基础官方教程
| 官中帮助 | https://publish.obsidian.md/help-zh/ |
|---|---|
| 官英帮助 | https://help.obsidian.md/ |
| Repo | https://github.com/obsidianmd/obsidian-help |
Obsidian开发者官方文档
Obsidian Community Hub 社区导航
由社区搭建的资源聚合网站，内容丰富。
| PKMer | Pkmer (github.com) |
|---|---|
| PKM-er/awesome-obsidian-zh: Obsidian 优秀中文插件、主题与资源 (github.com) |
信息流
新闻和社区动态
视频教程
| Youtube | By | Update |
|---|---|---|
| Create Your Own Obsidian Plugin | Antone Heyward | 4 years ago |
| How to create a plugin for Obsidian | @phibr0 | 3 years ago |
个人开发者分享
教程，工作流。可能有重复。欢迎自荐互荐。
| Author | Url | 构建工具 |
|---|---|---|
| Hananoshika Yomaru | Obsidian Plugin 101 - Hananoshika Yomaru | bun |
| Liam Cain | Unofficial API FAQ |
Easy Start （Sample Plugin）
只实现了简单功能的样例插件，如果只想接触一两个功能可以参考。
michaeljohnn/obsidian-textfileview-plugin-sample 2years ago
一个开发自定义 Obsidian TextFileView 插件的示例，包括自定义 TextFileView、文件操作、自动保存、卸载处理、SASS 以及其他所需代码逻辑。
其余我就不在此列举了。github 搜索关键词：obsidian-vue-starter obsidian-react-starter 等。
开发工具
| Url | Update |
|---|---|
| Obsidian Tools | Last Week |
| 开发者工具Obsidian 插件开发文档 (luhaifeng666.github.io) | 2 years ago |
批量获取上架插件的源码仓库
- 我用过的（最新）：konhi/obsidian-repositories-downloader
- 📦 learn, analyze and inspire from every obsidian.md plugin!
- 截至2025年3月7日，可供下载的插件有2258个，总大小为7.2G。
- 下载巨慢，不推荐。另外7G的仓库过于巨大，建议另外找学习方案。
- 没用过：luckman212/obsidian-plugin-downloader
- 没用过：claremacrae/obsidian-repos-downloader
进阶开发选项
对于具体插件的优秀实现解析我会放到文档里。
API 文档一览
| 官方API | obsidianmd/obsidian-api: Type definitions for the latest Obsidian API. (github.com) |
|---|---|
| 参考文档 | AbstractTextComponent | Obsidian 插件开发文档 (luhaifeng666.github.io) |
| Liam Cain | Unofficial API FAQ（未汉化） |
社区库
Canvas 白板
obsidianmd/jsoncanvas: An open file format for infinite canvas data. (github.com)
JSON Canvas — An open file format for infinite canvas data.
编辑器 CodeMirror 6
- Getting Started with CodeMirror 6 by NothingIsLost 4 years
其他可能需要参考的技术栈
贡献者 - Obsidian 中文帮助 - Obsidian Publish文中罗列了Obsidian开发相关的代码仓库。
贡献者
Issue和Pr都欢迎。接受网站/博客推荐，插件推荐（帮助解析一下原理），插件开发的奇思妙想都可以。
最后，让我们重温Obsidian官方宣言，让我们的插件为Obsidian和她的用户赋能。
