class Jekyll::Site
Attributes
Public Class Methods
Public: Initialize a new Site.
config - A Hash containing site configuration details.
# File lib/jekyll/site.rb, line 18 def initialize(config) @config = config.clone %w(safe lsi highlighter baseurl exclude include future unpublished show_drafts limit_posts keep_files gems).each do |opt| self.send("#{opt}=", config[opt]) end # Source and destination may not be changed after the site has been created. @source = File.expand_path(config['source']).freeze @dest = File.expand_path(config['destination']).freeze @reader = Jekyll::Reader.new(self) # Initialize incremental regenerator @regenerator = Regenerator.new(self) @liquid_renderer = LiquidRenderer.new(self) self.plugin_manager = Jekyll::PluginManager.new(self) self.plugins = plugin_manager.plugins_path self.file_read_opts = {} self.file_read_opts[:encoding] = config['encoding'] if config['encoding'] self.permalink_style = config['permalink'].to_sym Jekyll.sites << self reset setup end
Public Instance Methods
# File lib/jekyll/site.rb, line 236 def categories post_attr_hash('categories') end
Remove orphaned files and empty directories in destination.
Returns nothing.
# File lib/jekyll/site.rb, line 191 def cleanup site_cleaner.cleanup! end
The list of collection names.
Returns an array of collection names from the configuration,
or an empty array if the `collections` key is not set.
# File lib/jekyll/site.rb, line 126 def collection_names case config['collections'] when Hash config['collections'].keys when Array config['collections'] when nil [] else raise ArgumentError, "Your `collections` key must be a hash or an array." end end
The list of collections and their corresponding Jekyll::Collection instances. If config is set, a new instance is created for each item in the collection. If config is not set, a new hash is returned.
Returns a Hash containing collection name-to-instance pairs.
# File lib/jekyll/site.rb, line 118 def collections @collections ||= Hash[collection_names.map { |coll| [coll, Jekyll::Collection.new(self, coll)] } ] end
Get the to be written documents
Returns an Array of Documents which should be written
# File lib/jekyll/site.rb, line 302 def docs_to_write documents.select(&:write?) end
Get all the documents
Returns an Array of all Documents
# File lib/jekyll/site.rb, line 309 def documents collections.reduce(Set.new) do |docs, (_, collection)| docs + collection.docs + collection.files end.to_a end
# File lib/jekyll/site.rb, line 315 def each_site_file %w(pages static_files docs_to_write).each do |type| send(type).each do |item| yield item end end end
Check that the destination dir isn't the source dir or a directory parent to the source dir.
# File lib/jekyll/site.rb, line 104 def ensure_not_in_dest dest_pathname = Pathname.new(dest) Pathname.new(source).ascend do |path| if path == dest_pathname raise Errors::FatalException.new "Destination directory cannot be or contain the Source directory." end end end
Get the implementation class for the given Converter. Returns the Converter instance implementing the given Converter. klass - The Class of the Converter to fetch.
# File lib/jekyll/site.rb, line 269 def find_converter_instance(klass) converters.find { |klass_| klass_.instance_of?(klass) } || raise("No Converters found for #{klass}") end
Returns the FrontmatterDefaults or creates a new FrontmatterDefaults if it doesn't already exist.
Returns The FrontmatterDefaults
# File lib/jekyll/site.rb, line 327 def frontmatter_defaults @frontmatter_defaults ||= FrontmatterDefaults.new(self) end
Run each of the Generators.
Returns nothing.
# File lib/jekyll/site.rb, line 151 def generate generators.each do |generator| generator.generate(self) end end
Public: Prefix a given path with the destination directory.
paths - (optional) path elements to a file or directory within the
destination directory
Returns a path which is prefixed with the destination directory.
# File lib/jekyll/site.rb, line 364 def in_dest_dir(*paths) paths.reduce(dest) do |base, path| Jekyll.sanitized_path(base, path) end end
Public: Prefix a given path with the source directory.
paths - (optional) path elements to a file or directory within the
source directory
Returns a path which is prefixed with the source directory.
# File lib/jekyll/site.rb, line 352 def in_source_dir(*paths) paths.reduce(source) do |base, path| Jekyll.sanitized_path(base, path) end end
Whether to perform a full rebuild without incremental regeneration
Returns a Boolean: true for a full rebuild, false for normal build
# File lib/jekyll/site.rb, line 334 def incremental?(override = {}) override['incremental'] || config['incremental'] end
klass - class or module containing the subclasses. Returns array of instances of subclasses of parameter. Create array of instances of the subclasses of the class or module passed in as argument.
# File lib/jekyll/site.rb, line 279 def instantiate_subclasses(klass) klass.descendants.select { |c| !safe || c.safe }.sort.map do |c| c.new(config) end end
Construct a Hash of Posts indexed by the specified Post attribute.
post_attr - The String name of the Post attribute.
Examples
post_attr_hash('categories') # => { 'tech' => [<Post A>, <Post B>], # 'ruby' => [<Post B>] }
Returns the Hash: { attr => posts } where
attr - One of the values for the requested attribute. posts - The Array of Posts with the given attr value.
# File lib/jekyll/site.rb, line 223 def post_attr_hash(post_attr) # Build a hash map based on the specified post attribute ( post attr => # array of posts ) then sort each array in reverse order. hash = Hash.new { |h, key| h[key] = [] } posts.docs.each { |p| p.data[post_attr].each { |t| hash[t] << p } if p.data[post_attr] } hash.values.each { |posts| posts.sort!.reverse! } hash end
# File lib/jekyll/site.rb, line 206 def posts collections['posts'] ||= Collection.new(self, 'posts') end
# File lib/jekyll/site.rb, line 64 def print_stats if @config['profile'] puts @liquid_renderer.stats_table end end
Public: Read, process, and write this Site to output.
Returns nothing.
# File lib/jekyll/site.rb, line 54 def process reset read generate render cleanup write print_stats end
Returns the publisher or creates a new publisher if it doesn't already exist.
Returns The Publisher
# File lib/jekyll/site.rb, line 342 def publisher @publisher ||= Publisher.new(self) end
Read Site data from disk and load it into internal data structures.
Returns nothing.
# File lib/jekyll/site.rb, line 142 def read reader.read limit_posts! Jekyll::Hooks.trigger :site, :post_read, self end
Warns the user if permanent links are relative to the parent directory. As this is a deprecated function of Jekyll.
Returns
# File lib/jekyll/site.rb, line 289 def relative_permalinks_are_deprecated if config['relative_permalinks'] Jekyll.logger.abort_with "Since v3.0, permalinks for pages" " in subfolders must be relative to the" " site source directory, not the parent" " directory. Check http://jekyllrb.com/docs/upgrading/" " for more info." end end
Render the site to the destination.
Returns nothing.
# File lib/jekyll/site.rb, line 160 def render relative_permalinks_are_deprecated payload = site_payload Jekyll::Hooks.trigger :site, :pre_render, self, payload collections.each do |_, collection| collection.docs.each do |document| if regenerator.regenerate?(document) document.output = Jekyll::Renderer.new(self, document, payload).run document.trigger_hooks(:post_render) end end end pages.flatten.each do |page| if regenerator.regenerate?(page) page.output = Jekyll::Renderer.new(self, page, payload).run page.trigger_hooks(:post_render) end end Jekyll::Hooks.trigger :site, :post_render, self, payload rescue Errno::ENOENT # ignore missing layout dir end
Reset Site details.
Returns nothing
# File lib/jekyll/site.rb, line 73 def reset self.time = (config['time'] ? Utils.parse_date(config['time'].to_s, "Invalid time in _config.yml.") : Time.now) self.layouts = {} self.pages = [] self.static_files = [] self.data = {} @collections = nil @regenerator.clear_cache @liquid_renderer.reset if limit_posts < 0 raise ArgumentError, "limit_posts must be a non-negative number" end Jekyll::Hooks.trigger :site, :after_reset, self end
Load necessary libraries, plugins, converters, and generators.
Returns nothing.
# File lib/jekyll/site.rb, line 93 def setup ensure_not_in_dest plugin_manager.conscientious_require self.converters = instantiate_subclasses(Jekyll::Converter) self.generators = instantiate_subclasses(Jekyll::Generator) end
Prepare site data for site payload. The method maintains backward compatibility if the key 'data' is already used in _config.yml.
Returns the Hash to be hooked to site.data.
# File lib/jekyll/site.rb, line 244 def site_data config['data'] || data end
The Hash payload containing site-wide data.
Returns the Hash: { “site” => data } where data is a Hash with keys:
"time" - The Time as specified in the configuration or the current time if none was specified. "posts" - The Array of Posts, sorted chronologically by post date and then title. "pages" - The Array of all Pages. "html_pages" - The Array of HTML Pages. "categories" - The Hash of category values and Posts. See Site#post_attr_hash for type info. "tags" - The Hash of tag values and Posts. See Site#post_attr_hash for type info.
# File lib/jekyll/site.rb, line 261 def site_payload Drops::UnifiedPayloadDrop.new self end
Write static files, pages, and posts.
Returns nothing.
# File lib/jekyll/site.rb, line 198 def write each_site_file do |item| item.write(dest) if regenerator.regenerate?(item) end regenerator.write_metadata Jekyll::Hooks.trigger :site, :post_write, self end
Private Instance Methods
Limits the current posts; removes the posts which exceed the #limit_posts
Returns nothing
# File lib/jekyll/site.rb, line 375 def limit_posts! if limit_posts > 0 limit = posts.docs.length < limit_posts ? posts.docs.length : limit_posts self.posts.docs = posts.docs[-limit, limit] end end