GROWI Docs

# GROWI プラグインとは

GROWI プラグインは、GROWI の機能を拡張するための仕組みです。プラグイン開発によって、GROWI のコアシステムを変更することなく、カスタム機能の追加や既存の機能を変更できます。このページでは、プラグイン開発者向けに、プラグイン開発の基本的な情報を提供します。

実際には、1つの Git リポジトリが 1つのプラグインとして扱われます。現時点では GitHub のリポジトリのみに対応していますが、将来的には他の Git ホスティングサービスにも対応する予定です。

# プラグインのメリット

  1. モジュール性：機能を独立したモジュールとして開発できる
  2. 再利用性：開発したプラグインを複数の GROWI インスタンスで使用できる
  3. 保守性：コアシステムとは独立して更新・メンテナンスできる
  4. 共有：コミュニティと共有して他のユーザーも利用できる

# プラグインの種類

GROWI では以下の3種類のプラグインがサポートされています。

これらのプラグインの種類は排他的なものではなく、1つの Git リポジトリ内で複数の種類のプラグイン機能を提供できます。例えば、スクリプトプラグインでありながら同時にテーマプラグインの機能も提供するといった実装も可能です。詳細は プラグイン開発の基本 を参照してください。

# 1. スクリプトプラグイン

クライアント側の JavaScript を使用して GROWI の機能を拡張するプラグインです。主にフロントエンドの表示や動作をカスタマイズします。詳細は スクリプトプラグインを開発する をご参照ください。

用途例：

  • Markdown レンダリングのカスタマイズ
  • UI コンポーネントの追加や変更
  • 外部 API との連携
  • データの可視化機能の追加

# 2. テンプレートプラグイン

GROWI で使用できるページテンプレートを提供するプラグインです。詳細は テンプレートプラグインを開発する をご参照ください。

用途例：

  • 議事録テンプレート
  • プロジェクト計画書テンプレート
  • チェックリストテンプレート
  • 週報・月報テンプレート

# 3. テーマプラグイン

GROWI の外観をカスタマイズするプラグインです。詳細は テーマプラグインを開発する をご参照ください。

用途例：

  • カスタムカラースキーム
  • レイアウトの変更
  • フォントやスタイルのカスタマイズ

# プラグインのインストール方法

GROWI プラグインをインストールする方法は、プラグイン をご参照ください。

# 関連情報

# 公式パッケージ

  • @growi/pluginkit (opens new window): GROWI プラグイン開発のための公式ユーティリティ（バージョン 1.1.0 以降で React フックを簡単に利用可能）

# 公式プラグイン

← プラグイン開発の基本 →