Navigation Menu

For desktop editors

To develop a plugin for ONLYOFFICE desktop editors, follow the instructions below.

  1. Create a folder on your machine and put there the index.html and config.json files.

  2. Pack all the plugin files within the plugin folder into a zip archive and change its extension to .plugin (all the plugin files and subfolders must be at the archive root).

  3. Install a plugin through the Plugin Manager.

    The plugin will appear in the sdkjs-plugins directory. The path to the folder depends on the operating system you use:

    • For Linux - home/<username>/.local/share/onlyoffice/desktopeditors/sdkjs-plugins/
    • For Windows - C:\Users\<username>\AppData\Local\ONLYOFFICE\DesktopEditors\data\sdkjs-plugins\
    • For macOS - Users/<username>/Library/Application Support/asc.onlyoffice.ONLYOFFICE/sdkjs-plugins/

    A plugin GUID will be used as the folder name. For example, {07FD8DFA-DFE0-4089-AL24-0730933CC80A}.

    Sdkjs-plugins folder

    You can edit the plugin and reload it to see the changes.

Debugging

To debug ONLYOFFICE plugins in the desktop editors, use the --ascdesktop-support-debug-info flag. To do this, follow the instructions here depending on the operating system you use.

Debug

Get Help

  • If you have any questions about ONLYOFFICE Docs, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).