提交您的插件

如果您想在Obsidian社区中分享您的插件，最好的方式时把它提交到官方清单中。一旦我们预览并发布了您的插件，用户可以直接通过Obsidian安装它，我们也会在Obsidian的站点上在插件目录中展示它。

你只需要将您插件的原始版本提交。在您的插件发布后，用户可以通过GitHub直接从Obsidian下载新版本。

前提条件

为完成此指南，您需要：

• 一个 GitHub账号。

在开始前

在提交您的插件前，确认您的仓库根文件夹下有如下文件：

• 一个描述插件目的的 README.md 和如何使用它。
• 一个 LICENSE 以明确其他人被允许如何使用该插件和它的源码。如果你需要帮助为你的插件添加license，可以参考选择一个License.
• 一个描述你的插件的manifest.json。更多信息，参考 Manifest

第1步：发布您的插件到GitHub

模板仓库

如果您从我们的模板仓库创建了插件，可以跳过此步骤

为了预览您的插件，我们需要在GitHub上获得源码。如果您不熟悉GitHub，请参考如何创建一个新仓库

第2步：创建一个发布版

在这一步骤，您会准备好一个准备提交插件的发布版

1. 在manifest.json中更新到一个新版本，并带有详情（遵守此规则 Semantic Versioning），如1.0.0作为原始发布示例。你只可以用数字和句点。

2. 创建一个GitHub release。发布的标签版本可以与您中的版本相匹配

3. 为发布版输入一个名字，并在描述栏中加以描述。Obsidian不会用发布名做任何事，所以尽可能地放轻松，以你喜欢的方式来命名。

4. 上传如下发布版插件附件，以二进制附件的形式。

   • main.js
   • manifest.json
   • styles.css (optional)（可选项）

第3步：提交您的插件以供预览

在这一步，你会向Obsidian团队提交您的插件以供预览。

1. 在community-plugins.json中，添加一个位于末尾的新入口

   {
     "id": "doggo-dictation",
     "name": "Doggo Dictation",
     "author": "John Dolittle",
     "description": "Transcribes dog speech into notes.",
     "repo": "drdolittle/doggo-dictation"
   }
   

   • id, name, author, 和 description 决定了您的插件如何展示给用户，并且与您对应的 Manifest中的属性相对应。
   • 您插件有唯一的id，搜索community-plugins.json以确认现存插件没有相同的id。该id不会包含obsidian
   • repo是您GitHub仓库的路径，举个例子，如果您的GitHub repo位于https://github.com/your-username/your-repo-name，路径就是your-username/your-repo-name

   记得在前一个entry入口的闭合大括号}后添加一个逗号。

2. Select Commit changes... in the upper-right corner. 在右上角选择提交更改…

3. Select Propose changes. 选择确认变更

4. Select Create pull request. 选择创建PR

5. Select Preview, and then select Community Plugin.选择预览，然后选择社区插件

6. Click Create pull request. 点击创建PR

7. 在PR的name中输入“添加[...]插件”，[...]就在你插件的name

8. 在描述中填入PR详细信息。对于复选框内的括号内，插入x，把他们标记为完成。

9. Click Create pull request (for the last time 🤞).点击创建PR（最后一次）

现在您已经将插件提交到了Obsidian 的插件目录。稍后会收到我们可爱的机器人的初始审批。得到最后的结果需要几分钟时间

• 如果看到你的 PR 上出现 Ready to review (审核就绪) 标签，意味着您的提交已经通过了自动审批
• 如果看到在你的 PR 上出现Validation failed（确认失败） 标签，你需要解决所有列表上的问题直到机器人分配 Ready to review 标签。

一旦您的提交审核就绪，你可以等待 Obsidian 团队来审核。

需要多长时间审核我的插件？

审核您的提交所需的时间要看 Obsidian 团队的工作负荷情况。团队还比较小，所以当您等待插件审核时请保持耐心

第4步：处理审核意见

一旦审核员审核完您的插件，他们会为您的 PR添加一个审核结果。审核员可能会要求你升级插件，或他们会提供如何改进的建议。

处理所有要求的更改并更新 GitHub release。在 PR 上留个 comment，以便让我们知道你已经处理完反馈意见了。不要开个新 PR。

如果所有的更改要求已经处理过了，我们会尽快发布插件。

Note 注意

一旦 Obsidian 团队成员发布了您的插件，其他社区成员也能够同时审核你的提交

接下来

一旦我们预览并发布了您的插件，是时候将它公布到社区了：

在论坛的 Share & showcase（ 分享和展示）中发布

• 在 Discord的#updates 频道发布。你需要developerrole（开发者身份） 才能在#updates频道上发布

LINKS TO THIS PAGE 链接到此页面

Beta-testing plugins Beta 测试插件

Home主页

Release your plugin with GitHub Actions使用 GitHub Actions 发布你的插件