Parent

Files

Class/Module Index [+]

Quicksearch

Jekyll::Configuration

Constants

DEFAULTS

Default options. Overridden by values in _config.yml. Strings rather than symbols are used for compatibility with YAML.

Public Instance Methods

backwards_compatibilize() click to toggle source

Public: Ensure the proper options are set in the configuration to allow for backwards-compatibility with Jekyll pre-1.0

Returns the backwards-compatible configuration

# File lib/jekyll/configuration.rb, line 207
def backwards_compatibilize
  config = clone
  # Provide backwards-compatibility
  if config.key?('auto') || config.key?('watch')
    Jekyll.logger.warn "Deprecation:", "Auto-regeneration can no longer" +
                        " be set from your configuration file(s). Use the"+
                        " --watch/-w command-line option instead."
    config.delete('auto')
    config.delete('watch')
  end

  if config.key? 'server'
    Jekyll.logger.warn "Deprecation:", "The 'server' configuration option" +
                        " is no longer accepted. Use the 'jekyll serve'" +
                        " subcommand to serve your site with WEBrick."
    config.delete('server')
  end

  if config.key? 'server_port'
    Jekyll.logger.warn "Deprecation:", "The 'server_port' configuration option" +
                        " has been renamed to 'port'. Please update your config" +
                        " file accordingly."
    # copy but don't overwrite:
    config['port'] = config['server_port'] unless config.key?('port')
    config.delete('server_port')
  end

  if config.key? 'pygments'
    Jekyll.logger.warn "Deprecation:", "The 'pygments' configuration option" +
                        " has been renamed to 'highlighter'. Please update your" +
                        " config file accordingly. The allowed values are 'rouge', " +
                        "'pygments' or null."

    config['highlighter'] = 'pygments' if config['pygments']
    config.delete('pygments')
  end

  ]include exclude].each do |option|
    if config.fetch(option, []).is_a?(String)
      Jekyll.logger.warn "Deprecation:", "The '#{option}' configuration option" +
        " must now be specified as an array, but you specified" +
        " a string. For now, we've treated the string you provided" +
        " as a list of comma-separated values."
      config[option] = csv_to_array(config[option])
    end
    config[option].map!(&:to_s)
  end

  if config.fetch('markdown', 'kramdown').to_s.downcase.eql?("maruku")
    Jekyll::Deprecator.deprecation_message "You're using the 'maruku' " +
      "Markdown processor. Maruku support has been deprecated and will " +
      "be removed in 3.0.0. We recommend you switch to Kramdown."
  end
  config
end
config_files(override) click to toggle source

Public: Generate list of configuration files from the override

override - the command-line options hash

Returns an Array of config files

# File lib/jekyll/configuration.rb, line 134
def config_files(override)
  # Be quiet quickly.
  Jekyll.logger.log_level = :error if quiet?(override)

  # Get configuration from <source>/_config.yml or <source>/<config_file>
  config_files = override.delete('config')
  if config_files.to_s.empty?
    default = ]yml yaml].find(Proc.new { 'yml' }) do |ext|
      File.exists? Jekyll.sanitized_path(source(override), "_config.#{ext}")
    end
    config_files = Jekyll.sanitized_path(source(override), "_config.#{default}")
    @default_config_file = true
  end
  config_files = [config_files] unless config_files.is_a? Array
  config_files
end
csv_to_array(csv) click to toggle source

Public: Split a CSV string into an array containing its values

csv - the string of comma-separated values

Returns an array of the values contained in the CSV

# File lib/jekyll/configuration.rb, line 199
def csv_to_array(csv)
  csv.split(",").map(&:strip)
end
fix_common_issues() click to toggle source
# File lib/jekyll/configuration.rb, line 263
def fix_common_issues
  config = clone

  if config.key?('paginate') && (!config['paginate'].is_a?(Integer) || config['paginate'] < 1)
    Jekyll.logger.warn "Config Warning:", "The `paginate` key must be a" +
      " positive integer or nil. It's currently set to '#{config['paginate'].inspect}'."
    config['paginate'] = nil
  end

  config
end
quiet?(override = {}) click to toggle source
# File lib/jekyll/configuration.rb, line 114
def quiet?(override = {})
  override['quiet'] || self['quiet'] || DEFAULTS['quiet']
end
read_config_file(file) click to toggle source

Public: Read configuration and return merged Hash

file - the path to the YAML file to be read in

Returns this configuration, overridden by the values in the file

# File lib/jekyll/configuration.rb, line 156
def read_config_file(file)
  next_config = safe_load_file(file)
  raise ArgumentError.new("Configuration file: (INVALID) #{file}".yellow) unless next_config.is_a?(Hash)
  Jekyll.logger.info "Configuration file:", file
  next_config
rescue SystemCallError
  if @default_config_file
    Jekyll.logger.warn "Configuration file:", "none"
    {}
  else
    Jekyll.logger.error "Fatal:", "The configuration file '#{file}' could not be found."
    raise LoadError, "The Configuration file '#{file}' could not be found."
  end
end
read_config_files(files) click to toggle source

Public: Read in a list of configuration files and merge with this hash

files - the list of configuration file paths

Returns the full configuration, with the defaults overridden by the values in the configuration files

# File lib/jekyll/configuration.rb, line 177
def read_config_files(files)
  configuration = clone

  begin
    files.each do |config_file|
      new_config = read_config_file(config_file)
      configuration = Utils.deep_merge_hashes(configuration, new_config)
    end
  rescue ArgumentError => err
    Jekyll.logger.warn "WARNING:", "Error reading configuration. " +
                 "Using defaults (and options)."
    $stderr.puts "#{err}"
  end

  configuration.fix_common_issues.backwards_compatibilize
end
safe_load_file(filename) click to toggle source
# File lib/jekyll/configuration.rb, line 118
def safe_load_file(filename)
  case File.extname(filename)
  when /\.toml/
    TOML.load_file(filename)
  when /\.ya?ml/
    SafeYAML.load_file(filename)
  else
    raise ArgumentError, "No parser for '#{filename}' is available. Use a .toml or .y(a)ml file instead."
  end
end
source(override) click to toggle source

Public: Directory of the Jekyll source folder

override - the command-line options hash

Returns the path to the Jekyll source directory

# File lib/jekyll/configuration.rb, line 110
def source(override)
  override['source'] || self['source'] || DEFAULTS['source']
end
stringify_keys() click to toggle source

Public: Turn all keys into string

Return a copy of the hash where all its keys are strings

# File lib/jekyll/configuration.rb, line 101
def stringify_keys
  reduce({}) { |hsh,(k,v)| hsh.merge(k.to_s => v) }
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.