ONLYOFFICE Plugin Marketplace
ONLYOFFICE Plugin Marketplace (or Plugin Manager) allows users to explore all available plugins and install or remove any plugin with just one click right in the editors.
How to build and add your own plugin
In case you would like to create and add your own plugin to the marketplace, follow the steps below.
1. Fork the plugin marketplace repository: https://github.com/ONLYOFFICE/onlyoffice.github.io.
To further test in the web version, you need to enable GitHub Pages.
Clone the fork to your folder (e.g. work).
2. Add the plugin folder to the work/sdkjs-plugins/content folder.
3. Create your plugin as described in the API documentation.
Your plugin folder must contain three main files: config.json, index.html, and pluginCode.js. You also need to adjust its style, localize, add descriptions and icons.
4. Test your plugin in the desktop app.
Get ONLYOFFICE Desktop Editors and install your plugin as described here. You need to pack all the plugin files within the plugin folder into a zip archive, change its extension to .plugin, and add your plugin through the plugin manager.
Once tested, you can build your pugin further or fix the identified issues. To get the developer console, run the desktop app with the --ascdesktop-support-debug-info key. To do it, click the mouse in the document and press F1.
5. Test your plugin in the web.
Upload the plugin folder to GitHub.
Go to the work/store/plugin-dev/extension folder.
In the inject.js file, specify the path to your plugin on GitHub.
Launch Chrome browser and switch to the chrome://extensions/ page. Click Load unpacked and select the work/store/plugin-dev/extension folder.
Once done, run your ONLYOFFICE Document Server and find the plugin in the Plugin Manager.
Please note: when you are working on your plugin, it’s important to open the Plugin Manager to check and if necessary to improve how your plugin looks like there. You also need to take into consideration how the plugin looks like when switching to the Dark theme. Check the icons requirements.
6. When you are ready with the plugin creation, make pull request from your fork to the https://github.com/ONLYOFFICE/onlyoffice.github.io repository.
7. In case everything is OK and it works properly, we will approve the PR and the plugin will appear in the marketplace.
How to test your own plugin manager
If you want test your own plugin manager, you should create a variable in localStorage named "DeveloperMarketplaceUrl" and put the URL of your plugin manager in it. You will see a notification at the top of the plugin manager window, if you are not using the original plugin manager.