プラグイン

Hexoの強力なプラグインシステムにより、コアモジュールのソースコードを変更することなく、簡単に機能を拡張することができます。Hexoには2種類のプラグインがあります:

プラグインが比較的シンプルな場合は、スクリプトの使用が推奨されます。scriptsフォルダにJavaScriptファイルを置くだけで、Hexoが初期化時にそれらを読み込みます。

コードが複雑である場合や、NPMレジストリに公開したい場合は、プラグインの使用を推奨します。最初に、node_modulesフォルダ内にフォルダを作成します。このフォルダの名前はhexo-で始まる必要があり、そうでない場合Hexoはそれを無視します。

新しいフォルダには、少なくとも2つのファイルが含まれている必要があります：実際のJavaScriptコードを含むファイルと、プラグインの目的を説明し依存関係を設定するpackage.jsonファイルです。

.
├── index.js
└── package.json

少なくとも、package.jsonでname、version、mainエントリを設定する必要があります。例えば:

package.json

{
  "name": "hexo-my-plugin",
  "version": "0.0.1",
  "main": "index"
}

Hexoがこれを検出できるよう、hexoインスタンスのルートpackage.jsonにプラグインを依存関係として追加する必要があります。

Hexoが提供する公式ツールで開発を効率化できます:

プラグインが完成したら、他の人もそれを利用できるようプラグインリストに公開することを検討してみてください。プラグインを公開する手順は、ドキュメントの更新と非常に似ています。

hexojs/siteをフォークします。
リポジトリをコンピュータにクローンし、依存関係をインストールします。
$ git clone https://github.com/<username>/site.git
$ cd site
$ npm install
source/_data/plugins/に新しいyamlファイルを作成し、ファイル名としてプラグイン名を使用します。

source/_data/plugins/<your-plugin-name>.ymlを編集し、プラグインを追加します。例えば:

description: Server module for Hexo.
link: https://github.com/hexojs/hexo-server
tags:
  - official
  - server
  - console