コンソール

コンソールは、Hexoとユーザー間の橋渡しをします。利用可能なコンソールコマンドを登録し、説明します。

概要

hexo.extend.console.register(name, desc, options, function (args) {
  // ...
});

引数	説明
name	名前
説明	説明
オプション	オプション

引数`args`は関数に渡されます。これは、ユーザーがターミナルに入力する引数です。Minimistによって解析されます。

オプション

使用方法

コンソールコマンドの使用方法。例:

{
  usage: "[layout] <title>";
}
// hexo new [layout] <title>

引数

コンソールコマンドの各引数の説明。例:

{
  arguments: [
    { name: "layout", desc: "Post layout" },
    { name: "title", desc: "Post title" },
  ];
}

オプション

コンソールコマンドの各オプションの説明。例:

{
  options: [{ name: "-r, --replace", desc: "Replace existing files" }];
}

説明

コンソールコマンドに関する詳細情報。

例

hexo.extend.console.register(
  "config",
  "Display configuration",
  function (args) {
    console.log(hexo.config);
  },
);