ONLYOFFICEマーケットプレイスで自作プラグインを公開する方法

ONLYOFFICE Docsのバージョン7.2では、全く新しいプラグインマネージャーが追加され、利用可能なすべてのプラグインを探索し、エディタ内でワンクリックするだけでプラグインをインストールまたは削除できるようになりました。もしあなたが独自のプラグインを作成し、私たちのマーケットプレイスに追加したい場合は、以下のステップに従ってください。 

レポジトリをフォークする

注意：GitHub のアカウントと GitHub での作業の基本的な知識が必要です。

• プラグインマーケットプレイスのレポジトリをフォークします: https://github.com/ONLYOFFICE/onlyoffice.github.io。次のアドレスのレポを取得します：https://github.com/YOUR-USERNAME/ONLYOFFICE/onlyoffice.github.io。
• このリポジトリから自分のGitHub Pagesサイトを構築し、後でウェブ版でプラグインをテストします。
• フォークをあなたのローカルコンピュータにクローンしてください。
• onlyoffice.github.io/sdkjs-plugins/content/にあなたのプラグイン用のフォルダを追加してください。

プラグインを作成する

APIドキュメントに記載されているように、プラグインを作成してください。

プラグインフォルダには、config.json、index.html、pluginCode.jsの3つのファイルが必要です。また、スタイルの調整、ローカライズ、説明の追加、アイコンの追加も必要です。

デスクトップアプリでプラグインをテストする

ONLYOFFICE Desktop Editorsをダウンロードし、ここに記載されているようにプラグインをインストールします。

簡単に説明すると、pluginフォルダ内のすべてのプラグインファイルをZIPアーカイブにパックし、その拡張子を.pluginに変更し、プラグインマネージャを介してプラグインを追加する必要があります。

テストが完了したら、さらにプラグインを構築したり、特定された問題を修正したりすることができます。デバッグモードでデスクトップアプリを実行するには、--ascdesktop-support-debug-infoフラグを使用しましょう。これを行うには、使用しているOSに応じて、こちらの手順に従ってください。

作成したプラグインをウェブ上でテストする

拡張機能を作成するには、onlyoffice.github.io/store/plugin-dev/extension/inject.jsファイルを開き、URL_TO_PLUGIN変数にGitHub Pagesサイト上のプラグインへのパスを代入してください。

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（ドキュメントサーバ）を起動し、プラグインマネージャでプラグインを探します。

注意：あなたのプラグインで作業しているとき、チェックするためにプラグインマネージャを開くことが重要で、必要であれば、あなたのプラグインがそこでどのように見えるかを改善することができます。また、ダークテーマに切り替えたときにプラグインがどのように見えるかを考慮する必要があります。

プラグインを送信する

プラグインの準備ができたら、フォークからgithub.com/ONLYOFFICE/onlyoffice.github.ioのリポジトリにプルリクエストを行ってください。問題がなく、正常に動作する場合は、PRを承認し、プラグインがマーケットプレイスに表示されます。