Class: Nanoc::Filters::Pandoc Private

Inherits:
Nanoc::Filter show all
Defined in:
lib/nanoc/filters/pandoc.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 [Pandoc](johnmacfarlane.net/pandoc/) using [PandocRuby](github.com/alphabetum/pandoc-ruby).

Arguments can be passed to PandocRuby in two ways:

  • Use the ‘:args` option. This approach is more flexible, since it allows passing an array instead of a hash.

  • Pass the arguments directly to the filter. With this approach, only hashes can be passed, which is more limiting than the ‘:args` approach.

The ‘:args` approach is recommended.

Examples:

Passing arguments using ‘:arg`


filter :pandoc, args: [:s, {:f => :markdown, :to => :html}, 'no-wrap', :toc]

Passing arguments not using ‘:arg`


filter :pandoc, :f => :markdown, :to => :html

Parameters:

  • content (String) —

    The content to filter

Returns:

  • (String) —

    The filtered content



30
31
32
33
34
 
# File 'lib/nanoc/filters/pandoc.rb', line 30

def run(content, params = {})
  args = params.key?(:args) ? params[:args] : params

  PandocRuby.convert(content, *args)
end