class Jekyll::Page

Constants

ATTRIBUTES_FOR_LIQUID

Attributes for Liquid templates

FORWARD_SLASH
HTML_EXTENSIONS

A set of extensions that are considered HTML or HTML-like so we should not alter them, this includes .xhtml through XHTM5.

Attributes

basename[RW]
content[RW]
data[RW]
dir[W]
ext[RW]
extname[RW]
name[RW]
output[RW]
pager[RW]
site[RW]

Public Class Methods

new(site, base, dir, name) click to toggle source

Initialize a new Page.

site - The Site object. base - The String path to the source. dir - The String path between the source and the file. name - The String filename of the file.

# File lib/jekyll/page.rb, line 40
def initialize(site, base, dir, name)
  @site = site
  @base = base
  @dir  = dir
  @name = name
  @path = if site.in_theme_dir(base) == base # we're in a theme
            site.in_theme_dir(base, dir, name)
          else
            site.in_source_dir(base, dir, name)
          end

  process(name)
  read_yaml(File.join(base, dir), name)

  data.default_proc = proc do |_, key|
    site.frontmatter_defaults.find(File.join(dir, name), type, key)
  end

  Jekyll::Hooks.trigger :pages, :post_init, self
end

Public Instance Methods

destination(dest) click to toggle source

Obtain destination path.

dest - The String path to the destination dir.

Returns the destination file path String.

# File lib/jekyll/page.rb, line 157
def destination(dest)
  path = site.in_dest_dir(dest, URL.unescape_path(url))
  path = File.join(path, "index") if url.end_with?("/")
  path << output_ext unless path.end_with? output_ext
  path
end
dir() click to toggle source

The generated directory into which the page will be placed upon generation. This is derived from the permalink or, if permalink is absent, will be '/'

Returns the String destination directory.

# File lib/jekyll/page.rb, line 66
def dir
  if url.end_with?(FORWARD_SLASH)
    url
  else
    url_dir = File.dirname(url)
    url_dir.end_with?(FORWARD_SLASH) ? url_dir : "#{url_dir}/"
  end
end
html?() click to toggle source

Returns the Boolean of whether this Page is HTML or not.

# File lib/jekyll/page.rb, line 170
def html?
  HTML_EXTENSIONS.include?(output_ext)
end
index?() click to toggle source

Returns the Boolean of whether this Page is an index file or not.

# File lib/jekyll/page.rb, line 175
def index?
  basename == "index"
end
inspect() click to toggle source

Returns the object as a debug String.

# File lib/jekyll/page.rb, line 165
def inspect
  "#<Jekyll::Page @name=#{name.inspect}>"
end
path() click to toggle source

The path to the source file

Returns the path to the source file

# File lib/jekyll/page.rb, line 143
def path
  data.fetch("path") { relative_path }
end
process(name) click to toggle source

Extract information from the page filename.

name - The String filename of the page file.

Returns nothing.

# File lib/jekyll/page.rb, line 122
def process(name)
  self.ext = File.extname(name)
  self.basename = name[0..-ext.length - 1]
end
relative_path() click to toggle source

The path to the page source file, relative to the site source

# File lib/jekyll/page.rb, line 148
def relative_path
  File.join(*[@dir, @name].map(&:to_s).reject(&:empty?)).sub(%r!\A\/!, "")
end
render(layouts, site_payload) click to toggle source

Add any necessary layouts to this post

layouts - The Hash of {“name” => “layout”}. site_payload - The site payload Hash.

Returns String rendered page.

# File lib/jekyll/page.rb, line 133
def render(layouts, site_payload)
  site_payload["page"] = to_liquid
  site_payload["paginator"] = pager.to_liquid

  do_layout(site_payload, layouts)
end
template() click to toggle source

The template of the permalink.

Returns the template String.

# File lib/jekyll/page.rb, line 86
def template
  if !html?
    "/:path/:basename:output_ext"
  elsif index?
    "/:path/"
  else
    Utils.add_permalink_suffix("/:path/:basename", site.permalink_style)
  end
end
trigger_hooks(hook_name, *args) click to toggle source
# File lib/jekyll/page.rb, line 179
def trigger_hooks(hook_name, *args)
  Jekyll::Hooks.trigger :pages, hook_name, self, *args
end
url() click to toggle source

The generated relative url of this page. e.g. /about.html.

Returns the String url.

# File lib/jekyll/page.rb, line 99
def url
  @url ||= URL.new({
    :template     => template,
    :placeholders => url_placeholders,
    :permalink    => permalink,
  }).to_s
end
url_placeholders() click to toggle source

Returns a hash of URL placeholder names (as symbols) mapping to the desired placeholder replacements. For details see “url.rb”

# File lib/jekyll/page.rb, line 109
def url_placeholders
  {
    :path       => @dir,
    :basename   => basename,
    :output_ext => output_ext,
  }
end
write?() click to toggle source
# File lib/jekyll/page.rb, line 183
def write?
  true
end