@since 3.2.0
Runs the content through [Redcarpet](github.com/vmg/redcarpet). This method optionally takes processing options to pass on to Redcarpet.
@overload run(content, params={})
For Redcarpet 1.x @param [String] content The content to filter @option params [Array] :options ([]) A list of options to pass on to Redcarpet @return [String] The filtered content
@overload run(content, params={})
For Redcarpet 2.x @since 3.2.4 @param [String] content The content to filter @option params [Hash] :options ({}) A list of options to pass on to Redcarpet itself (not the renderer) @option params [::Redcarpet::Render::Base] :renderer (::Redcarpet::Render::HTML) The class of the renderer to use @option params [Hash] :renderer_options ({}) A list of options to pass on to the Redcarpet renderer @return [String] The filtered content
# File lib/nanoc/filters/redcarpet.rb, line 41 def run(content, params={}) if ::Redcarpet::VERSION > '2' options = params[:options] || {} renderer_class = params[:renderer] || ::Redcarpet::Render::HTML renderer_options = params[:renderer_options] || {} if options.is_a?(Array) warn 'WARNING: You are passing an array of options to the :redcarpet filter, but Redcarpet 2.x expects a hash instead. This will likely fail.' end if renderer_class == ::Redcarpet::Render::HTML_TOC renderer = renderer_class.new else renderer = renderer_class.new(renderer_options) end ::Redcarpet::Markdown.new(renderer, options).render(content) else options = params[:options] || [] ::Redcarpet.new(content, *options).to_html end end
Generated with the Darkfish Rdoc Generator 2.