Module: Jekyll

Defined in:
lib/jekyll/url.rb,
lib/jekyll.rb,
lib/jekyll/page.rb,
lib/jekyll/site.rb,
lib/jekyll/hooks.rb,
lib/jekyll/utils.rb,
lib/jekyll/errors.rb,
lib/jekyll/layout.rb,
lib/jekyll/plugin.rb,
lib/jekyll/reader.rb,
lib/jekyll/cleaner.rb,
lib/jekyll/command.rb,
lib/jekyll/excerpt.rb,
lib/jekyll/filters.rb,
lib/jekyll/version.rb,
lib/jekyll/document.rb,
lib/jekyll/external.rb,
lib/jekyll/renderer.rb,
lib/jekyll/converter.rb,
lib/jekyll/generator.rb,
lib/jekyll/publisher.rb,
lib/jekyll/stevenson.rb,
lib/jekyll/collection.rb,
lib/jekyll/deprecator.rb,
lib/jekyll/drops/drop.rb,
lib/jekyll/utils/ansi.rb,
lib/jekyll/convertible.rb,
lib/jekyll/log_adapter.rb,
lib/jekyll/regenerator.rb,
lib/jekyll/static_file.rb,
lib/jekyll/commands/new.rb,
lib/jekyll/entry_filter.rb,
lib/jekyll/tags/include.rb,
lib/jekyll/commands/help.rb,
lib/jekyll/configuration.rb,
lib/jekyll/related_posts.rb,
lib/jekyll/tags/post_url.rb,
lib/jekyll/commands/build.rb,
lib/jekyll/commands/clean.rb,
lib/jekyll/commands/serve.rb,
lib/jekyll/drops/url_drop.rb,
lib/jekyll/plugin_manager.rb,
lib/jekyll/tags/highlight.rb,
lib/jekyll/commands/doctor.rb,
lib/jekyll/drops/site_drop.rb,
lib/jekyll/liquid_renderer.rb,
lib/jekyll/utils/platforms.rb,
lib/jekyll/drops/jekyll_drop.rb,
lib/jekyll/liquid_extensions.rb,
lib/jekyll/converters/identity.rb,
lib/jekyll/converters/markdown.rb,
lib/jekyll/drops/document_drop.rb,
lib/jekyll/readers/data_reader.rb,
lib/jekyll/readers/page_reader.rb,
lib/jekyll/readers/post_reader.rb,
lib/jekyll/frontmatter_defaults.rb,
lib/jekyll/liquid_renderer/file.rb,
lib/jekyll/drops/collection_drop.rb,
lib/jekyll/liquid_renderer/table.rb,
lib/jekyll/readers/layout_reader.rb,
lib/jekyll/commands/serve/servlet.rb,
lib/jekyll/readers/collection_reader.rb,
lib/jekyll/drops/unified_payload_drop.rb,
lib/jekyll/readers/static_file_reader.rb,
lib/jekyll/converters/markdown/kramdown_parser.rb,
lib/jekyll/converters/markdown/rdiscount_parser.rb,
lib/jekyll/converters/markdown/redcarpet_parser.rb,
lib/jekyll/converters/smartypants.rb

Overview

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

Defined Under Namespace

Modules: Commands, Converters, Convertible, Deprecator, Drops, Errors, External, Filters, Hooks, LiquidExtensions, Tags, Utils Classes: Cleaner, Collection, CollectionReader, Command, Configuration, Converter, DataReader, Document, EntryFilter, Excerpt, FrontmatterDefaults, Layout, LayoutReader, LiquidRenderer, LogAdapter, Page, PageReader, Plugin, PluginManager, PostReader, Publisher, Reader, Regenerator, RelatedPosts, Renderer, Site, StaticFile, StaticFileReader, Stevenson, URL

Constant Summary collapse

VERSION = 
'3.1.0'
Generator = 
Class.new(Plugin)

Class Method Summary collapse

Class Method Details

.configuration(override = {}) ⇒ Object

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.



98
99
100
101
102
103
104
105
106
107
108
109
110
 
# 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 ⇒ Object

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.



86
87
88
 
# File 'lib/jekyll.rb', line 86

def env
  ENV["JEKYLL_ENV"] || "development"
end

.logger ⇒ Object

Public: Fetch the logger instance for this Jekyll process.

Returns the LogAdapter instance.



124
125
126
 
# File 'lib/jekyll.rb', line 124

def logger
  @logger ||= LogAdapter.new(Stevenson.new, (ENV["JEKYLL_LOG_LEVEL"] || :info).to_sym)
end

.logger=(writer) ⇒ Object

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.



135
136
137
 
# 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) ⇒ Object

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.



153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/jekyll.rb', line 153

def sanitized_path(base_directory, questionable_path)
  return base_directory if base_directory.eql?(questionable_path)

  clean_path = File.expand_path(questionable_path, "/")
  clean_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) ⇒ Object

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

timezone - the IANA Time Zone

Returns nothing



117
118
119
 
# File 'lib/jekyll.rb', line 117

def set_timezone(timezone)
  ENV['TZ'] = timezone
end

.sites ⇒ Object

Public: An array of sites

Returns the Jekyll sites created.



142
143
144
 
# File 'lib/jekyll.rb', line 142

def sites
  @sites ||= []
end