Class: Nanoc::Filters::RedCloth Private

Inherits:
Nanoc::Filter
  • Object
show all
Defined in:
lib/nanoc/filters/redcloth.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.

Instance Method Summary collapse

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 RedCloth. This method takes the following options:

  • :filter_class
  • :filter_html
  • :filter_ids
  • :filter_style
  • :hard_breaks
  • :lite_mode
  • :no_span_caps
  • :sanitize_htm

Each of these options sets the corresponding attribute on the RedCloth instance. For example, when the :hard_breaks => false option is passed to this filter, the filter will call r.hard_breaks = false (with r being the RedCloth instance).

Parameters:

  • content (String) —

    The content to filter

Returns:

  • (String) —

    The filtered content



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/nanoc/filters/redcloth.rb', line 30

def run(content, params = {})
  # Create formatter
  r = ::RedCloth.new(content)

  # Set options
  r.filter_classes = params[:filter_classes] if params.key?(:filter_classes)
  r.filter_html    = params[:filter_html]    if params.key?(:filter_html)
  r.filter_ids     = params[:filter_ids]     if params.key?(:filter_ids)
  r.filter_styles  = params[:filter_styles]  if params.key?(:filter_styles)
  r.hard_breaks    = params[:hard_breaks]    if params.key?(:hard_breaks)
  r.lite_mode      = params[:lite_mode]      if params.key?(:lite_mode)
  r.no_span_caps   = params[:no_span_caps]   if params.key?(:no_span_caps)
  r.sanitize_html  = params[:sanitize_html]  if params.key?(:sanitize_html)

  # Get result
  r.to_html
end