控制台

控制台是 Hexo 与用户之间的桥梁。它注册并描述了可用的控制台命令。

概述

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

参数	描述
name	名称
desc	描述
选项	选项

参数 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" }];
}

desc

有关控制台命令的更多详细信息。

示例

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