Class: Jekyll::Configuration

Inherits:
Hash
  • Object
show all
Defined in:
lib/jekyll/configuration.rb

Constant Summary collapse

DEFAULTS =

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

{
  'source'        => Dir.pwd,
  'destination'   => File.join(Dir.pwd, '_site'),
  'plugins'       => '_plugins',
  'layouts'       => '_layouts',
  'data_source'   =>  '_data',
  'keep_files'    => ['.git','.svn'],
  'gems'          => [],

  'timezone'      => nil,           # use the local timezone

  'encoding'      => nil,           # use the system encoding

  'safe'          => false,
  'detach'        => false,          # default to not detaching the server
  'show_drafts'   => nil,
  'limit_posts'   => 0,
  'lsi'           => false,
  'future'        => true,           # remove and make true just default
  'pygments'      => true,

  'relative_permalinks' => true,     # backwards-compatibility with < 1.0
                                     # will be set to false once 2.0 hits

  'markdown'      => 'maruku',
  'permalink'     => 'date',
  'baseurl'       => '/',
  'include'       => ['.htaccess'],
  'exclude'       => [],
  'paginate_path' => '/page:num',

  'markdown_ext'  => 'markdown,mkd,mkdn,md',
  'textile_ext'   => 'textile',

  'port'          => '4000',
  'host'          => '0.0.0.0',

  'excerpt_separator' => "\n\n",

  'maruku' => {
    'use_tex'    => false,
    'use_divs'   => false,
    'png_engine' => 'blahtex',
    'png_dir'    => 'images/latex',
    'png_url'    => '/images/latex'
  },

  'rdiscount' => {
    'extensions' => []
  },

  'redcarpet' => {
    'extensions' => []
  },

  'kramdown' => {
    'auto_ids'      => true,
    'footnote_nr'   => 1,
    'entity_output' => 'as_char',
    'toc_levels'    => '1..6',
    'smart_quotes'  => 'lsquo,rsquo,ldquo,rdquo',
    'use_coderay'   => false,

    'coderay' => {
      'coderay_wrap'              => 'div',
      'coderay_line_numbers'      => 'inline',
      'coderay_line_number_start' => 1,
      'coderay_tab_width'         => 4,
      'coderay_bold_every'        => 10,
      'coderay_css'               => 'style'
    }
  },

  'redcloth' => {
    'hard_breaks' => true
  }
}

Instance Method Summary collapse

Methods inherited from Hash

#deep_merge, #pluralized_array, #symbolize_keys, #symbolize_keys!

Instance Method Details

#backwards_compatibilize ⇒ Object

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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/jekyll/configuration.rb', line 185

def backwards_compatibilize
  config = clone
  # Provide backwards-compatibility
  if config.has_key?('auto') || config.has_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.has_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.has_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.has_key?('port')
    config.delete('server_port')
  end

  %w[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
  end
  config
end

#config_files(override) ⇒ Object

Public: Generate list of configuration files from the override

override - the command-line options hash

Returns an Array of config files



118
119
120
121
122
123
124
125
126
127
 
# File 'lib/jekyll/configuration.rb', line 118

def config_files(override)
  # Get configuration from <source>/_config.yml or <source>/<config_file>
  config_files = override.delete('config')
  if config_files.to_s.empty?
    config_files = File.join(source(override), "_config.yml")
    @default_config_file = true
  end
  config_files = [config_files] unless config_files.is_a? Array
  config_files
end

#csv_to_array(csv) ⇒ Object

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



177
178
179
 
# File 'lib/jekyll/configuration.rb', line 177

def csv_to_array(csv)
  csv.split(",").map(&:strip)
end

#fix_common_issues ⇒ Object 



224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/jekyll/configuration.rb', line 224

def fix_common_issues
  config = clone

  if config.has_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

#read_config_file(file) ⇒ Object

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



134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/jekyll/configuration.rb', line 134

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) ⇒ Object

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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/jekyll/configuration.rb', line 155

def read_config_files(files)
  configuration = clone

  begin
    files.each do |config_file|
      new_config = read_config_file(config_file)
      configuration = configuration.deep_merge(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) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
 
# File 'lib/jekyll/configuration.rb', line 102

def safe_load_file(filename)
  case File.extname(filename)
  when '.toml'
    TOML.load_file(filename)
  when /\.y(a)?ml/
    YAML.safe_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) ⇒ Object

Public: Directory of the Jekyll source folder

override - the command-line options hash

Returns the path to the Jekyll source directory



98
99
100
 
# File 'lib/jekyll/configuration.rb', line 98

def source(override)
  override['source'] || self['source'] || DEFAULTS['source']
end

#stringify_keys ⇒ Object

Public: Turn all keys into string

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



89
90
91
 
# File 'lib/jekyll/configuration.rb', line 89

def stringify_keys
  reduce({}) { |hsh,(k,v)| hsh.merge(k.to_s => v) }
end