Class: Nanoc3::Filters::Kramdown

Inherits:

Nanoc3::Filter

• Object
• Context
• Nanoc3::Filter
• Nanoc3::Filters::Kramdown

Defined in:

lib/nanoc3/filters/kramdown.rb

Constant Summary

Constants inherited from Nanoc3::Filter

Nanoc3::Filter::TMP_BINARY_ITEMS_DIR

Instance Attribute Summary

Attributes inherited from Nanoc3::Filter

#assigns

Instance Method Summary

• #run(content, params = {}) ⇒ String

  Runs the content through [Kramdown](kramdown.rubyforge.org/).

Methods inherited from Nanoc3::Filter

#depend_on, #filename, from_binary?, #initialize, #output_filename, to_binary?, type

Methods included from PluginRegistry::PluginMethods

#identifier, #identifiers, #named, #register

Methods inherited from Context

#get_binding, #initialize

Constructor Details

This class inherits a constructor from Nanoc3::Filter

Instance Method Details

#run(content, params = {}) ⇒ String

Runs the content through [Kramdown](kramdown.rubyforge.org/). Parameters passed to this filter will be passed on to Kramdown.

Parameters:

• content (String) —

  The content to filter

Returns:

• (String) —

  The filtered content

# File 'lib/nanoc3/filters/kramdown.rb', line 14

def run(content, params={})
  # Get result
  ::Kramdown::Document.new(content, params).to_html
end