保姆级Obisdian插件官方上架教程

1、开发查看官方文档开发插件2、上架前序步骤1、查看官方说明确保 Manifest.json等文件的合规性2、给仓库添加许可具体的区别可以看 如何选择开源许可证 - 阮一峰的网络日志3、按照社区规范检查一下自己的代码obsidian-releases/plugin-review.md at master · obsidianmd/obsidian-releases · GitHub建议安装官方插件进行本地检查减少时间成本https://github.com/obsidianmd/eslint-plugin4、确定自己的Readme.md文件中的内容改成了和自己插件相关的内容然后再推送自己的仓库中。演示gif制作网站https://www.flexclip.com/cn/editor/apphttps://www.freeconvert.com/zh/convert/webm-to-gif/download5、 创建 Release第一步确定版本号和代码来源最上方两个按钮-Tag版本标签图中你已经输入了 1.0.0。这是对当前代码状态的一个标记。通常我们用 v1.0.0 这样的格式。-Target目标分支图中选的是 main。意思是你要把 main 这个分支目前的最新代码作为 1.0.0版本发布出去。这部分通常保持默认即可。-第二步填写标题和更新日志中间部分-Release title发布标题给这次发布起个名字。比如可以直接写 Release v1.0.0或者 V1.0.0首次正式发布。-Release notes版本说明/更新日志告诉大家这次更新了什么。偷懒的办法点击Generate release notes自动生成更新日志按钮系统会自动把你最近的代码提交记录抓取过来填进框里。手动写在下面那个很大的空白框Describe this release里写一下新增了哪些功能、修复了哪些 Bug。-第三步上传打包好的文件下方虚线框-Attach binaries…附加二进制文件如果你写的是一个软件并且已经把它打包成了可以直接运行的程序比如.exe、.apk或者是.zip压缩包你可以直接把文件拖拽到这个虚线框里。- _注意如果只是想分享源代码这一步可以完全跳过系统会自动为打包一份源码压缩包。-第四步选择发布状态并提交最底部-Set as a pre-release设置为预发布版如果你的软件还没完全测试好是个测试版Beta / Alpha可以勾选这个。如果是正式给别人用的稳定版不要勾选。- 最后滚动到页面最底部截图里没截到点击绿色的Publish release发布按钮就大功告成了3、 创建好后 Fork什么是 Fork用一个通俗的比喻来解释想象 Obsidian 官方的插件列表obsidian-releases是一本公共的“黄页名录”。因为它是公共的官方不能允许任何人随便进去乱写所以你没有权限直接修改它。那你想把自己的名字加上去该怎么办呢Fork分叉/复制你拿去复印机把这本名录完整地“复印”了一份放到你自己的桌子上你的 GitHub 账号下。Edit修改你在自己复印的那本名录上加上了你的插件信息。Pull Request (简称 PR / 拉取请求)你拿着改好的复印件去找官方审核员说“嗨我在我的复印件上新增了我的信息请你检查一下如果没问题麻烦把它合并Merge到官方的原本名录里吧”总结一下Fork 就是把官方的代码库克隆一份到你自己的账号下方便你自由修改然后再把修改申请提交给官方。开始Fork只需要按照以下步骤在网页端操作即可不需要动用本地的代码命令行第一步去官方仓库 Fork 一份点击教程里给你的那个链接打开 Obsidian 官方的obsidian-releases仓库页面。登录你的 GitHub 账号。在页面右上角找到一个写着Fork的按钮点击它。页面会跳转询问你复印到哪里直接点击绿色的Create fork创建分支按钮。等待几秒钟你会发现页面变了左上角现在的名字变成了你的用户名/obsidian-releases。这就说明你已经在自己的地盘里了第二步修改配置文件填入你的插件信息在你刚才 Fork 过来的页面文件列表里往下划找到一个叫community-plugins.json的文件点击它。进入文件后在代码框的右上角找到一个✏️ 铅笔图标Edit this file点击它进入编辑模式。把光标滚到文件的最底部。你会看到很多别人已经写好的插件信息。⚠️ 极其重要的一步就像截图里提示的那样在最后一个插件的}后面加一个英文逗号,然后换行把你自己的插件信息一段{ ... }格式的代码粘贴进去。如果漏了逗号官方的程序会报错打回的。第三步保存并提交Commit PR填好后点击右上角的绿色按钮Commit changes…提交更改。在弹出的框里随便写句备注比如Add [你的插件名] plugin然后确认保存。保存后回到你的仓库首页你会看到一行提示说你的进度比官方仓库超前了This branch is 1 commit ahead of…。点击旁边的Contribute贡献然后点击Open pull request发起拉取请求。需要点击截图中那个绿色的Create pull request按钮,看到清单后按照提示仔细阅读每一项把你确认做到的项目从[ ]改成[x]注意 x 是小写且括号内不要有空格如果报错怎么办千万不要关闭这个 PR 重新开看提示是不是只需要在现有的基础上改对它就会自动重新检查。请按照以下步骤直接在网页上修复第一步进入编辑页面就在你截图的这个 PR 页面往上看点击标题下方的Files changed(已更改的文件)标签。找到你修改的community-plugins.json在代码块的右上角找到三个点...。点击...选择Edit file(编辑文件)。第二步检查并修复格式最关键请把光标滚到文件的最底部仔细对照以下正确格式和常见错误第三步重新提交确认修改无误后点击右上角的Commit changes按钮保存。保存后你可以切回到Conversation(对话)标签页。稍等一两分钟那个名为github-actions的机器人会自动重新检查你的代码。如果格式对了它会发一条全绿的通过消息4、最后第一步去查看机器人的“复查结果”点击页面左上角的Conversation(对话)标签页就在Commits旁边。往下滑到页面的最底部看看那个叫做github-actions的机器人有没有发新的消息或者底部有没有出现一个绿色的勾勾 ✅提示类似All checks have passed。如果变绿了说明你的代码格式已经通过了系统的自动检测第二步检查“上架申请单”是否填好关键在Conversation页面的最上面是你刚提交 PR 时自动生成的那一大段英文文本。里面有 Obsidian 官方要求填写的检查清单Checklist。检查一下里面的框框是不是都被你改成了[x]代表已确认完成。如果还是空的[ ]请点击那段文字右上角的...选择Edit编辑仔细阅读每一项要求确认没问题后把[ ]敲成[x]然后保存。第三步耐心等待官方审核只要机器人的检测Checks全部变绿并且你的申请单Checklist打好勾了你这边的所有工作就已经全部完成了接下来就是“等”。Obsidian 的官方团队全是真人会排队处理这些上架申请他们会去你的仓库里看一眼你的代码。如果一切顺利他们会直接合并Merge你的代码然后你会收到邮件通知你的插件就正式出现在 Obsidian 的官方插件市场里了如果需要修改官方人员会在刚才的Conversation页面给你留言比如让你改一下图标或者修复某个安全隐患。留意你的 GitHub 绑定的邮箱通知即可。最后的最后如果我的插件上架了欢迎大家来用啊~~~