Jekyll

Jekyll

Jekyll class

Constructor

new Jekyll(options)

Create a new Jekyll object

Source:
Parameters:
Name Type Description
options Object

Options for this Jekyll instance

Name Type Description
github GitHub

GitHub instance for this Jekyll object
owner String

Owner name of repo for this Jekyll object
repo String

Name of repo for this Jekyll object

Methods

collection(name, paramsopt) → {Promise.<Collection>}

Load a specific collection by name

Source:
Parameters:
Name Type Attributes Description
name String

Name of collection to load
params Object <optional>

Additional params (sent to github)
Returns:
Type:
Promise.<Collection>
  • Returns promise with a single Collection

collections(paramsopt) → {Promise.<Array>}

Load collections for this Jekyll instance

Source:
Parameters:
Name Type Attributes Description
params Object <optional>

Additional params (sent to github)
Returns:
Type:
Promise.<Array>
  • Returns promise with array of Collections

config(paramsopt) → {Promise.<Object>}

Load Jekyll config from repo (_config.yaml or _config.toml)

Source:
Parameters:
Name Type Attributes Description
params Object <optional>

Additional params (sent to github)
Returns:
Type:
Promise.<Object>
  • Returns promise with response data