Консоль служит для взаимодействия пользователей с Hexo. Регистрирует и описывает доступные консольные команды.

Краткий обзор

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

Значение из аргумента args передаётся в функцию. Свойство описывает вводимые через терминал данные. Анализируется с помощью Minimist.

Опции

usage

Добавление используемых команд в консоль. Например:

{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);
});