class Bunto::Excerpt
Attributes
Public Class Methods
Public Instance Methods
Fetch YAML front-matter data from related doc, without layout key
Returns Hash of doc data
# File lib/bunto/excerpt.rb, line 26 def data @data ||= doc.data.dup @data.delete("layout") @data.delete("excerpt") @data end
The UID for this doc (useful in feeds). e.g. /2008/11/05/my-awesome-doc
Returns the String UID.
# File lib/bunto/excerpt.rb, line 53 def id "#{doc.id}#excerpt" end
Check if excerpt includes a string
Returns true if the string passed in
# File lib/bunto/excerpt.rb, line 45 def include?(something) (output && output.include?(something)) || content.include?(something) end
Returns the shorthand String identifier of this doc.
# File lib/bunto/excerpt.rb, line 66 def inspect "<Excerpt: #{self.id}>" end
# File lib/bunto/excerpt.rb, line 70 def output @output ||= Renderer.new(doc.site, self, site.site_payload).run end
'Path' of the excerpt.
Returns the path for the doc this excerpt belongs to with excerpt appended
# File lib/bunto/excerpt.rb, line 38 def path File.join(doc.path, "#excerpt") end
# File lib/bunto/excerpt.rb, line 74 def place_in_layout? false end
# File lib/bunto/excerpt.rb, line 61 def to_liquid Bunto::Drops::ExcerptDrop.new(self) end
# File lib/bunto/excerpt.rb, line 57 def to_s output || content end
# File lib/bunto/excerpt.rb, line 33 def trigger_hooks(*); end
Protected Instance Methods
Internal: Extract excerpt from the content
By default excerpt is your first paragraph of a doc: everything before the first two new lines:
--- title: Example --- First paragraph with [link][1]. Second paragraph. [1]: http://example.com/
This is fairly good option for Markdown and Textile files. But might cause problems for HTML docs (which is quite unusual for Bunto
). If default excerpt delimiter is not good for you, you might want to set your own via configuration option `excerpt_separator`. For example, following is a good alternative for HTML docs:
# file: _config.yml excerpt_separator: "<!-- more -->"
Notice that all markdown-style link references will be appended to the excerpt. So the example doc above will have this excerpt source:
First paragraph with [link][1]. [1]: http://example.com/
Excerpts are rendered same time as content is rendered.
Returns excerpt String
# File lib/bunto/excerpt.rb, line 114 def extract_excerpt(doc_content) head, _, tail = doc_content.to_s.partition(doc.excerpt_separator) if tail.empty? head else "" << head << "\n\n" << tail.scan(%r!^ {0,3}\[[^\]]+\]:.+$!).join("\n") end end