API

このドキュメントでは、APIに関する詳細な情報を提供します。Hexoのソースコードを変更したり、新しいプラグインを作成したいと考えている方にとって特に役立ちます。Hexoの基本的な使用方法に興味がある場合は、代わりにドキュメントを参照してください。

このドキュメントは、Hexo 3以降でのみ有効であることに注意してください。

初期化

まず、Hexoインスタンスを作成する必要があります。新しいインスタンスは、ウェブサイトのルートディレクトリであるbase_dirと、初期化オプションを含むオブジェクトの2つの引数を取ります。次に、このインスタンスに対してinitメソッドを呼び出して初期化します。これにより、Hexoは設定とプラグインを読み込みます。

var Hexo = require("hexo");
var hexo = new Hexo(process.cwd(), {});

hexo.init().then(function () {
  // ...
});
オプション 説明 デフォルト
debug デバッグモードを有効にします。ターミナルにデバッグメッセージを表示し、ルートディレクトリにdebug.logを保存します。 false
safe セーフモードを有効にします。プラグインを読み込みません。 false
silent サイレントモードを有効にします。ターミナルにメッセージを表示しません。 false
config 設定ファイルのパスを指定します。 _config.yml
draft / drafts 下書きを投稿リストに追加できるようにします。
例: hexo.locals.get('posts')を使用する場合		 _config.ymlのrender_drafts

ファイルの読み込み

Hexoは、ファイルを読み込むための2つのメソッド、loadとwatchを提供します。loadは、sourceフォルダ内のすべてのファイルとテーマデータをロードするために使用されます。watchはloadと同じことを行いますが、ファイルの変更を継続的に監視し始めます。

どちらのメソッドも、ファイルのリストを読み込み、対応するプロセッサに渡します。すべてのファイルが処理された後、ジェネレータを呼び出してルートを作成します。

hexo.load().then(function () {
  // ...
});

hexo.watch().then(function () {
  // You can call hexo.unwatch() later to stop watching.
});

コマンドの実行

Hexoインスタンスのcallメソッドを使用して、任意のコンソールコマンドを明示的に呼び出すことができます。この呼び出しは、コンソールコマンドの名前とオプション引数の2つの引数を取ります。さまざまなコンソールコマンドでさまざまなオプションを使用できます。

hexo.call("generate", {}).then(function () {
  // ...
});
hexo.call("list", { _: ["post"] }).then(function () {
  // ...
});

終了

コンソールコマンドの成功または失敗の完了時に、exitメソッドを呼び出す必要があります。これにより、Hexoは正常に終了し、データベースの保存などの重要なタスクを完了できます。

hexo
  .call("generate")
  .then(function () {
    return hexo.exit();
  })
  .catch(function (err) {
    return hexo.exit(err);
  });
次へ