Class: Jekyll::Site
- Inherits:
-
Object
- Object
- Jekyll::Site
- Defined in:
- lib/jekyll/site.rb
Instance Attribute Summary collapse
-
#categories ⇒ Object
Returns the value of attribute categories.
-
#config ⇒ Object
Returns the value of attribute config.
-
#dest ⇒ Object
Returns the value of attribute dest.
-
#exclude ⇒ Object
Returns the value of attribute exclude.
-
#layouts ⇒ Object
Returns the value of attribute layouts.
-
#lsi ⇒ Object
Returns the value of attribute lsi.
-
#pages ⇒ Object
Returns the value of attribute pages.
-
#permalink_style ⇒ Object
Returns the value of attribute permalink_style.
-
#posts ⇒ Object
Returns the value of attribute posts.
-
#pygments ⇒ Object
Returns the value of attribute pygments.
-
#source ⇒ Object
Returns the value of attribute source.
-
#static_files ⇒ Object
Returns the value of attribute static_files.
-
#tags ⇒ Object
Returns the value of attribute tags.
Instance Method Summary collapse
-
#filter_entries(entries) ⇒ Object
Filter out any files/directories that are hidden or backup files (start with “.” or “#” or end with “~”), or contain site content (start with “_”), or are excluded in the site configuration, unless they are web server files such as ‘.htaccess’.
-
#initialize(config) ⇒ Site
constructor
Initialize the site
config
is a Hash containing site configurations details. -
#paginate(page) ⇒ Object
Paginates the blog’s posts.
-
#post_attr_hash(post_attr) ⇒ Object
Constructs a hash map of Posts indexed by the specified Post attribute.
-
#process ⇒ Object
Do the actual work of processing the site and generating the real deal.
- #read ⇒ Object
-
#read_directories(dir = '') ⇒ Object
Reads the directories and finds posts, pages and static files that will become part of the valid site according to the rules in
filter_entries
. -
#read_layouts(dir = '') ⇒ Object
Read all the files in <source>/<dir>/_layouts and create a new Layout object with each one.
-
#read_posts(dir) ⇒ Object
Read all the files in <source>/<dir>/_posts and create a new Post object with each one.
- #render ⇒ Object
- #reset ⇒ Object
- #setup ⇒ Object
-
#site_payload ⇒ Object
The Hash payload containing site-wide data.
- #textile(content) ⇒ Object
-
#write ⇒ Object
Write static files, pages and posts.
Constructor Details
#initialize(config) ⇒ Site
Initialize the site
+config+ is a Hash containing site configurations details
Returns <Site>
11 12 13 14 15 16 17 18 19 20 21 22 23 |
# File 'lib/jekyll/site.rb', line 11 def initialize(config) self.config = config.clone self.source = File.(config['source']) self.dest = config['destination'] self.lsi = config['lsi'] self.pygments = config['pygments'] self.permalink_style = config['permalink'].to_sym self.exclude = config['exclude'] || [] self.reset self.setup end |
Instance Attribute Details
#categories ⇒ Object
Returns the value of attribute categories.
4 5 6 |
# File 'lib/jekyll/site.rb', line 4 def categories @categories end |
#config ⇒ Object
Returns the value of attribute config.
4 5 6 |
# File 'lib/jekyll/site.rb', line 4 def config @config end |
#dest ⇒ Object
Returns the value of attribute dest.
4 5 6 |
# File 'lib/jekyll/site.rb', line 4 def dest @dest end |
#exclude ⇒ Object
Returns the value of attribute exclude.
4 5 6 |
# File 'lib/jekyll/site.rb', line 4 def exclude @exclude end |
#layouts ⇒ Object
Returns the value of attribute layouts.
4 5 6 |
# File 'lib/jekyll/site.rb', line 4 def layouts @layouts end |
#lsi ⇒ Object
Returns the value of attribute lsi.
4 5 6 |
# File 'lib/jekyll/site.rb', line 4 def lsi @lsi end |
#pages ⇒ Object
Returns the value of attribute pages.
4 5 6 |
# File 'lib/jekyll/site.rb', line 4 def pages @pages end |
#permalink_style ⇒ Object
Returns the value of attribute permalink_style.
4 5 6 |
# File 'lib/jekyll/site.rb', line 4 def permalink_style @permalink_style end |
#posts ⇒ Object
Returns the value of attribute posts.
4 5 6 |
# File 'lib/jekyll/site.rb', line 4 def posts @posts end |
#pygments ⇒ Object
Returns the value of attribute pygments.
4 5 6 |
# File 'lib/jekyll/site.rb', line 4 def pygments @pygments end |
#source ⇒ Object
Returns the value of attribute source.
4 5 6 |
# File 'lib/jekyll/site.rb', line 4 def source @source end |
#static_files ⇒ Object
Returns the value of attribute static_files.
4 5 6 |
# File 'lib/jekyll/site.rb', line 4 def static_files @static_files end |
#tags ⇒ Object
Returns the value of attribute tags.
4 5 6 |
# File 'lib/jekyll/site.rb', line 4 def @tags end |
Instance Method Details
#filter_entries(entries) ⇒ Object
Filter out any files/directories that are hidden or backup files (start with “.” or “#” or end with “~”), or contain site content (start with “_”), or are excluded in the site configuration, unless they are web server files such as ‘.htaccess’
243 244 245 246 247 248 249 |
# File 'lib/jekyll/site.rb', line 243 def filter_entries(entries) entries = entries.reject do |e| unless ['.htaccess'].include?(e) ['.', '_', '#'].include?(e[0..0]) || e[-1..-1] == '~' || self.exclude.include?(e) end end end |
#paginate(page) ⇒ Object
Paginates the blog’s posts. Renders the index.html file into paginated directories, ie: page2/index.html, page3/index.html, etc and adds more site-wide data.
+page+ is the index.html Page that requires pagination
=> { “page” => <Number>,
"per_page" => <Number>,
"posts" => [<Post>],
"total_posts" => <Number>,
"total_pages" => <Number>,
"previous_page" => <Number>,
"next_page" => <Number> }
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 |
# File 'lib/jekyll/site.rb', line 263 def paginate(page) all_posts = site_payload['site']['posts'] pages = Pager.calculate_pages(all_posts, self.config['paginate'].to_i) (1..pages).each do |num_page| pager = Pager.new(self.config, num_page, all_posts, pages) if num_page > 1 newpage = Page.new(self, self.source, page.dir, page.name) newpage.render(self.layouts, site_payload.merge({'paginator' => pager.to_hash})) newpage.dir = File.join(page.dir, "page#{num_page}") newpage.basename = 'index.html' self.pages << newpage else page.render(self.layouts, site_payload.merge({'paginator' => pager.to_hash})) end end end |
#post_attr_hash(post_attr) ⇒ Object
Constructs a hash map of Posts indexed by the specified Post attribute
Returns => [<Post>]
217 218 219 220 221 222 223 224 |
# File 'lib/jekyll/site.rb', line 217 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 { |hash, key| hash[key] = Array.new } self.posts.each { |p| p.send(post_attr.to_sym).each { |t| hash[t] << p } } hash.values.map { |sortme| sortme.sort! { |a, b| b <=> a} } return hash end |
#process ⇒ Object
Do the actual work of processing the site and generating the real deal. Now has 4 phases; reset, read, render, write. This allows rendering to have full site payload available.
Returns nothing
96 97 98 99 100 101 |
# File 'lib/jekyll/site.rb', line 96 def process self.reset self.read self.render self.write end |
#read ⇒ Object
103 104 105 106 |
# File 'lib/jekyll/site.rb', line 103 def read self.read_layouts # existing implementation did this at top level only so preserved that self.read_directories end |
#read_directories(dir = '') ⇒ Object
Reads the directories and finds posts, pages and static files that will become part of the valid site according to the rules in filter_entries
.
The +dir+ String is a relative path used to call this method
recursively as it descends through directories
Returns nothing
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 |
# File 'lib/jekyll/site.rb', line 189 def read_directories(dir = '') base = File.join(self.source, dir) entries = filter_entries(Dir.entries(base)) self.read_posts(dir) entries.each do |f| f_abs = File.join(base, f) f_rel = File.join(dir, f) if File.directory?(f_abs) next if self.dest.sub(/\/$/, '') == f_abs read_directories(f_rel) elsif !File.symlink?(f_abs) first3 = File.open(f_abs) { |fd| fd.read(3) } if first3 == "---" # file appears to have a YAML header so process it as a page pages << Page.new(self, self.source, dir, f) else # otherwise treat it as a static file static_files << StaticFile.new(self, self.source, dir, f) end end end end |
#read_layouts(dir = '') ⇒ Object
Read all the files in <source>/<dir>/_layouts and create a new Layout object with each one.
Returns nothing
112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/jekyll/site.rb', line 112 def read_layouts(dir = '') base = File.join(self.source, dir, "_layouts") return unless File.exists?(base) entries = [] Dir.chdir(base) { entries = filter_entries(Dir['*.*']) } entries.each do |f| name = f.split(".")[0..-2].join(".") self.layouts[name] = Layout.new(self, base, f) end end |
#read_posts(dir) ⇒ Object
Read all the files in <source>/<dir>/_posts and create a new Post object with each one.
Returns nothing
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 |
# File 'lib/jekyll/site.rb', line 128 def read_posts(dir) base = File.join(self.source, dir, '_posts') return unless File.exists?(base) entries = Dir.chdir(base) { filter_entries(Dir['**/*']) } # first pass processes, but does not yet render post content entries.each do |f| if Post.valid?(f) post = Post.new(self, self.source, dir, f) if post.published self.posts << post post.categories.each { |c| self.categories[c] << post } post..each { |c| self.[c] << post } end end end self.posts.sort! end |
#render ⇒ Object
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
# File 'lib/jekyll/site.rb', line 149 def render self.posts.each do |post| post.render(self.layouts, site_payload) end self.pages.dup.each do |page| if Pager.pagination_enabled?(self.config, page.name) paginate(page) else page.render(self.layouts, site_payload) end end self.categories.values.map { |ps| ps.sort! { |a, b| b <=> a} } self..values.map { |ps| ps.sort! { |a, b| b <=> a} } rescue Errno::ENOENT => e # ignore missing layout dir end |
#reset ⇒ Object
25 26 27 28 29 30 31 32 |
# File 'lib/jekyll/site.rb', line 25 def reset self.layouts = {} self.posts = [] self.pages = [] self.static_files = [] self.categories = Hash.new { |hash, key| hash[key] = [] } self. = Hash.new { |hash, key| hash[key] = [] } end |
#setup ⇒ Object
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/jekyll/site.rb', line 34 def setup # Check to see if LSI is enabled. require 'classifier' if self.lsi # Set the Markdown interpreter (and Maruku self.config, if necessary) case self.config['markdown'] when 'rdiscount' begin require 'rdiscount' def markdown(content) RDiscount.new(content).to_html end rescue LoadError puts 'You must have the rdiscount gem installed first' end when 'maruku' begin require 'maruku' def markdown(content) Maruku.new(content).to_html end if self.config['maruku']['use_divs'] require 'maruku/ext/div' puts 'Maruku: Using extended syntax for div elements.' end if self.config['maruku']['use_tex'] require 'maruku/ext/math' puts "Maruku: Using LaTeX extension. Images in `#{self.config['maruku']['png_dir']}`." # Switch off MathML output MaRuKu::Globals[:html_math_output_mathml] = false MaRuKu::Globals[:html_math_engine] = 'none' # Turn on math to PNG support with blahtex # Resulting PNGs stored in `images/latex` MaRuKu::Globals[:html_math_output_png] = true MaRuKu::Globals[:html_png_engine] = self.config['maruku']['png_engine'] MaRuKu::Globals[:html_png_dir] = self.config['maruku']['png_dir'] MaRuKu::Globals[:html_png_url] = self.config['maruku']['png_url'] end rescue LoadError puts "The maruku gem is required for markdown support!" end else raise "Invalid Markdown processor: '#{self.config['markdown']}' -- did you mean 'maruku' or 'rdiscount'?" end end |
#site_payload ⇒ Object
The Hash payload containing site-wide data
Returns => {“time” => <Time>,
"posts" => [<Post>],
"categories" => [<Post>]
231 232 233 234 235 236 237 |
# File 'lib/jekyll/site.rb', line 231 def site_payload {"site" => self.config.merge({ "time" => Time.now, "posts" => self.posts.sort { |a,b| b <=> a }, "categories" => post_attr_hash('categories'), "tags" => post_attr_hash('tags')})} end |
#textile(content) ⇒ Object
87 88 89 |
# File 'lib/jekyll/site.rb', line 87 def textile(content) RedCloth.new(content).to_html end |
#write ⇒ Object
Write static files, pages and posts
Returns nothing
171 172 173 174 175 176 177 178 179 180 181 |
# File 'lib/jekyll/site.rb', line 171 def write self.posts.each do |post| post.write(self.dest) end self.pages.each do |page| page.write(self.dest) end self.static_files.each do |sf| sf.write(self.dest) end end |