关于此仓库
此仓库用于托管 Obsidian 的公开发布版本,以及我们的社区插件和主题目录。
Obsidian 不是开源软件,此仓库不包含 Obsidian 的源代码。但是,如果您希望为 Obsidian 做出贡献,可以通过我们的强大插件系统轻松实现。插件指南可以在这里找到:https://docs.obsidian.md
此仓库不接受问题报告。如果您对插件有疑问或问题,请前往它们各自的仓库提交。如果您对 Obsidian 核心功能有疑问或问题,请在我们的社区发帖:https://obsidian.md/community
提交您的插件或主题
开启拉取请求时,请切换到预览模式并选择通过我们的提交清单的选项。按照 JSON 文件中的惯例提交您的条目,我们将审核您的提交。
感谢您提交您的创作!
政策
所有提交必须符合我们的开发者政策
社区主题
要将您的主题添加到我们的主题商店,请对 community-css-theme.json
文件发起拉取请求。请将您的主题添加到列表末尾。
name
:您主题的唯一名称。不能与其他主题重复。author
:显示的作者名称。repo
:GitHub 仓库标识符,格式为user-name/repo-name
,如果您的 GitHub 仓库位于https://github.com/user-name/repo-name
。screenshot
:您主题的截图路径。modes
:如果您的主题支持深色和浅色模式,填写["dark", "light"]
。否则,如果您的主题只支持深色模式,填写["dark"]
;如果只支持浅色模式,填写["light"]
。publish
:如果您的主题支持 Obsidian Publish,将此项设为true
。否则省略此项。
要使您的主题与 Obsidian Publish 兼容,您可以使用 applyCss
和 applyCssByLink
在 Obsidian Publish 站点的开发者控制台中测试您的 CSS,这样您就不需要实际拥有站点来测试您的 publish.css
。您可以在我们的帮助站点上进行测试:https://help.obsidian.md/
applyCss
接受一个 CSS 字符串,您可以使用反引号(模板字符串)来编写多行 CSS。applyCssByLink
接受一个链接并加载 CSS,建议使用 GitHub 原始文件 URL。
社区插件
社区插件格式
要将您的插件添加到列表中,请对 community-plugins.json
文件发起拉取请求。请将您的插件添加到列表末尾。
id
:您插件的唯一 ID。确保与您的manifest.json
中的 ID 相同。name
:您插件的名称。author
:作者名称。description
:简短描述您的插件功能。repo
:GitHub 仓库标识符,格式为user-name/repo-name
,如果您的 GitHub 仓库位于https://github.com/user-name/repo-name
。
社区插件的获取方式
- Obsidian 将读取
community-plugins.json
中的插件列表。 name
、author
和description
字段用于搜索。- 当用户打开您插件的详情页面时,Obsidian 将从您的 GitHub 仓库中获取
manifest.json
和README.md
。 - 仓库中的
manifest.json
仅用于确定最新版本。实际文件从您的 GitHub 发布中获取。 - 如果您的
manifest.json
要求的 Obsidian 版本高于当前运行的应用程序,将查阅您的versions.json
以找到与之兼容的最新插件版本。 - 当用户选择安装您的插件时,Obsidian 将查找与
manifest.json
中版本号相同的 GitHub 发布标签。 - Obsidian 将下载
manifest.json
、main.js
和styles.css
(如果有),并将它们存储在保管库的适当位置。
宣布插件/主题的首次公开发布
- 一旦被接纳到插件/主题浏览器,您可以宣布您的插件/主题公开可用:
- 在论坛作为展示,以及
- 在 Discord 服务器的
#updates
频道。(您需要developer
角色才能在该频道发帖;您可以在这里获得该角色。)
- 在"正式"提交到插件/主题浏览器之前,您也可以将插件的第一个可用版本作为公开测试版进行宣布。这样,您可以获得一些测试者的反馈。建议使用 BRAT 插件来让感兴趣的测试者尽可能轻松地安装。