控制台

控制台是 Hexo 與使用者之間的橋樑。它註冊並描述可用的控制台命令。

概要

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

參數	描述
name	名稱
desc	描述
options	選項

一個 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);
  },
);