API Reference

Hexo Class

Defined in lib/core/index.js:17
Extends EventEmitter

Description

All Hexo methods and functions are defined inside of this namespace.

Constructor

Hexo

Defined in lib/core/index.js:17

All Hexo methods and functions are defined inside of this namespace.

Methods

bootstrap

(baseDir, args) chainable
Defined in lib/core/index.js:58

Bootstraps Hexo environment.

Parameters

call

(name, [args], [callback]) chainableasync
Defined in lib/core/index.js:193

Calls a console plugin.

Parameters

constant

(name, value) chainable
Defined in lib/core/index.js:33

Defines a constant.

Parameters

Properties

base_dir

final
Defined in lib/core/index.js:99

The path of base directory, equals to the current working directory (CWD).

config

Defined in lib/loaders/config.js:83

Configuration.

core_dir

final
Defined in lib/core/index.js:69

The path of core directory of Hexo.

env

final
Defined in lib/core/index.js:109

Environment variables.

This object contains the following attributes:

  • debug: Determines whether debug mode is on.
  • safe: Determines whether safe mode is on.
  • silent: Determines whether silent mode is on.
  • env: Node.js environment variable. Default to development.
  • version: Hexo version number.
  • init: Determines whether Hexo has been initalized.

extend

Defined in lib/loaders/extend.js:5

The extend instance.

lib_dir

final
Defined in lib/core/index.js:79

The path of library directory of Hexo.

model

Defined in lib/loaders/database.js:11

The model instance.

plugin_dir

Defined in lib/loaders/config.js:140

The path of plugin directory.

post

Defined in lib/core/index.js:181

See post.

public_dir

Defined in lib/loaders/config.js:120

The path of public directory.

scaffold_dir

Defined in lib/loaders/config.js:160

The path of scaffold directory.

script_dir

Defined in lib/loaders/config.js:150

The path of script directory.

source_dir

Defined in lib/loaders/config.js:130

The path of source directory.

theme_dir

Defined in lib/loaders/config.js:170

The path of theme directory.

theme_script_dir

Defined in lib/loaders/config.js:182

The path of theme script directory.

util

Defined in lib/core/index.js:136

See util.

version

final
Defined in lib/core/index.js:89

Hexo version number.

Events

deployAfter

(err)
Defined in lib/plugins/console/deploy.js:50

Fired after deployment.

Parameters

deployBefore

Defined in lib/plugins/console/deploy.js:40

Fired before deployment.

exit

Defined in lib/init.js:67

Fired when Hexo is about to exit.

new

(path, content)
Defined in lib/post/create.js:109

Fired when a new post created.

Parameters

  • path String

    The full path of the new post

  • content String

    The content of the new post

processAfter

(base)
Defined in lib/box/index.js:328

Fired after the process has been done.

Parameters

  • base String

    The base path of the box

processBefore

(base)
Defined in lib/box/index.js:291

Fired before the process started.

Parameters

  • base String

    The base path of the box

ready

Defined in lib/init.js:39

Fired when Hexo is ready.

server

Defined in lib/plugins/console/server.js:40

Fired after server started.