Module: JekyllPluginHooks

Included in:

JekyllPluginTemplate

Defined in:

lib/jekyll_hooks.rb

Overview

The Jekyll processing steps are described in jekyllrb.com/tutorials/orderofinterpretation/

The Jekyll log level defaults to :info, which means all the Jekyll.logger statements below will not generate output. You can control the log level when you start Jekyll. To set the log level to :debug, write an entery into _config.yml, like this: plugin_loggers:

JekyllPluginHooks: debug

Jekyll::Hooks.register accepts an optional parameter:

:priority determines the load order for the hook plugins.
  Valid values are: :lowest, :low, :normal, :high, and :highest.
  Highest priority matches are applied first, lowest priority are applied last.
  The default value is :normal

Each hook, except the clean hook, can set a boolean flag, called ‘site.safe`, that informs Jekyll if this plugin may be safely executed in an environment where arbitrary code execution is not allowed. This is used by GitHub Pages to determine which core plugins may be used, and which are unsafe to run. If your plugin does not allow for arbitrary code execution, set this to true. GitHub Pages still will not load your plugin, but if you submit it for inclusion in core, it is best for this to be correct! Default value is false. The hooks for pages, posts and documents access safe via pages.site.safe, posts.site.safe and documents.site.safe, respectively.