module Jekyll

Frozen-string-literal: true Encoding: utf-8

Convertible provides methods for converting a pagelike item from a certain type of markup into actual content

Requires

self.site -> Jekyll::Site
self.content
self.content=
self.data=
self.ext=
self.output=
self.name
self.path
self.type -> :page, :post or :draft

Public: Methods that generate a URL for a resource such as a Post or a Page.

Examples

URL.new({
  :template => /:categories/:title.html",
  :placeholders => {:categories => "ruby", :title => "something"}
}).to_s

Frozen-string-literal: true Copyright: 2015 Jekyll - MIT License Encoding: utf-8

Constants

Generator
VERSION

Public Class Methods

configuration(override = {}) click to toggle source

Public: Generate a Jekyll configuration Hash by merging the default options with anything in _config.yml, and adding the given options on top.

override - A Hash of config directives that override any options in both

the defaults and the config file. See Jekyll::Configuration::DEFAULTS for a
list of option names and their defaults.

Returns the final configuration Hash.

# File lib/jekyll.rb, line 98
def configuration(override = {})
  config = Configuration[Configuration::DEFAULTS]
  override = Configuration[override].stringify_keys
  unless override.delete('skip_config_files')
    config = config.read_config_files(config.config_files(override))
  end

  # Merge DEFAULTS < _config.yml < override
  config = Utils.deep_merge_hashes(config, override).stringify_keys
  set_timezone(config['timezone']) if config['timezone']

  config
end

env() click to toggle source

Public: Tells you which Jekyll environment you are building in so you can skip tasks if you need to. This is useful when doing expensive compression tasks on css and images and allows you to skip that when working in development.

# File lib/jekyll.rb, line 86
def env
  ENV["JEKYLL_ENV"] || "development"
end

logger() click to toggle source

Public: Fetch the logger instance for this Jekyll process.

Returns the LogAdapter instance.

# File lib/jekyll.rb, line 124
def logger
  @logger ||= LogAdapter.new(Stevenson.new, (ENV["JEKYLL_LOG_LEVEL"] || :info).to_sym)
end

logger=(writer) click to toggle source

Public: Set the log writer.

New log writer must respond to the same methods
as Ruby's interal Logger.

writer - the new Logger-compatible log transport

Returns the new logger.

# File lib/jekyll.rb, line 135
def logger=(writer)
  @logger = LogAdapter.new(writer, (ENV["JEKYLL_LOG_LEVEL"] || :info).to_sym)
end

sanitized_path(base_directory, questionable_path) click to toggle source

Public: Ensures the questionable path is prefixed with the base directory

and prepends the questionable path with the base directory if false.

base_directory - the directory with which to prefix the questionable path questionable_path - the path we're unsure about, and want prefixed

Returns the sanitized path.

# File lib/jekyll.rb, line 153
def sanitized_path(base_directory, questionable_path)
  return base_directory if base_directory.eql?(questionable_path)

  questionable_path.insert(0, '/') if questionable_path.start_with?('~')
  clean_path = File.expand_path(questionable_path, "/")
  clean_path.sub!(/\A\w\:\//, '/')

  if clean_path.start_with?(base_directory.sub(/\A\w\:\//, '/'))
    clean_path
  else
    File.join(base_directory, clean_path)
  end
end

set_timezone(timezone) click to toggle source

Public: Set the TZ environment variable to use the timezone specified

timezone - the IANA Time Zone

Returns nothing

# File lib/jekyll.rb, line 117
def set_timezone(timezone)
  ENV['TZ'] = timezone
end

sites() click to toggle source

Public: An array of sites

Returns the Jekyll sites created.

# File lib/jekyll.rb, line 142
def sites
  @sites ||= []
end