如何在 ONLYOFFICE 市场中发布您自己的插件

2022年10月05日作者: Alina

ONLYOFFICE 文档版本 7.2 中,我们增加了全新的插件管理器,便于您探索所有可用插件并在编辑器中一键安装或删除任意插件。如果您想在市场中创建并添加自己的插件,请参考以下步骤。

How to publish your own plugin in ONLYOFFICE marketplace

创建存储库分支(Fork)

请注意:您需要首先拥有一个 GitHub 账户并了解使用 GitHub 的基本知识。

构建插件

根据我们 API 文档中的说明来创建插件。您还可参考本视频

这里,您的插件文件夹中必须包含三个主要文件:config.jsonindex.html 以及 pluginCode.js。此外还需要调整插件的样式和本地化语言,并为其添加描述和图标。

在桌面应用中测试插件

下载 ONLYOFFICE 桌面编辑器并根据此处给出的说明安装您的插件。

简单地说,您需要将插件文件夹内的所有插件文件打包到 zip 包中,然后将其扩展名更改为 .plugin 并通过插件管理器添加插件。

测试完成后,您就可进一步构建插件,或是对发现的错误进行修复。如需打开开发人员控制台,请在添加 --ascdesktop-support-debug-info 键后运行桌面应用。要做到这一点,根据您的操作系统,按照此说明进行操作。

在网页版中测试插件

为了创建扩展,请打开 onlyoffice.github.io/store/plugin-dev/extension/inject.js  文件并将您的插件在 GitHub Pages 站点上的路径分配给 URL_TO_PLUGIN 变量:

var URL_TO_PLUGIN = "https://YOUR-USERNAME.github.io/onlyoffice.github.io/sdkjs-plugins/content/helloworld/"

onlyoffice.github.io/store/plugin-dev/extension 文件夹是新的扩展。将它上传到浏览器,运行您的ONLYOFFICE Docs(文档服务器),在插件管理器中找到该插件。

请注意:在开发插件的过程中,您应随时打开插件管理器进行检查并在必要时改善插件外观。这是一项非常重要的工作。您还需要考虑在切换至深色主题时插件的外观如何。

提交您的插件

在完成了插件的创建工作后,您可从自己的分支中向 https://github.com/ONLYOFFICE/onlyoffice.github.io 库发出 pull request。

如果插件能够正常工作,我们将对此 PR 进行批准,然后插件就能上架市场啦。

How to publish your own plugin in ONLYOFFICE marketplace