Class: Nanoc::Filters::Kramdown Private

Inherits:
Nanoc::Filter show all
Defined in:
lib/nanoc/filters/kramdown.rb

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Constant Summary

Constants inherited from Nanoc::Filter

Nanoc::Filter::TMP_BINARY_ITEMS_DIR

Instance Attribute Summary

Attributes inherited from Nanoc::Filter

#assigns

Instance Method Summary collapse

Methods inherited from Nanoc::Filter

#depend_on, #filename, from_binary?, #initialize, #output_filename, requires, setup, #setup_and_run, to_binary?, type

Methods included from Int::PluginRegistry::PluginMethods

#all, #identifier, #identifiers, #named, #register

Methods inherited from Int::Context

#get_binding, #initialize

Constructor Details

This class inherits a constructor from Nanoc::Filter

Instance Method Details

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

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

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

Parameters:

  • content (String) —

    The content to filter

Returns:

  • (String) —

    The filtered content



12
13
14
15
16
17
18
19
20
 
# File 'lib/nanoc/filters/kramdown.rb', line 12

def run(content, params = {})
  document = ::Kramdown::Document.new(content, params)

  document.warnings.each do |warning|
    $stderr.puts "kramdown warning: #{warning}"
  end

  document.to_html
end