控制台（Console）

控制台是 Hexo 与开发者之间沟通的桥梁。 它注册并描述了可用的控制台命令。

概要

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

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

An argument args will be passed into the function. This is the argument that users type into the terminal. It’s parsed by Minimist.

选项

用法

The usage of a console command. 例如：

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

arguments

控制台各个参数的说明。 例如：

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

options

控制台的各个选项的说明。 例如：

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

desc

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

示例

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