Class: Kramdown::Document

Inherits:

Object

• Object
• Kramdown::Document

Defined in:

lib/kramdown/man.rb

Instance Method Summary

• #to_man(options = {}) ⇒ String

  Converts the parsed markdown document to a man page.

Instance Method Details

#to_man(options = {}) ⇒ String

Converts the parsed markdown document to a man page.

Parameters:

• options (Hash) (defaults to: {}) —

  Additional options.

Returns:

• (String) —

  The converted man page contents.

Since:

• 1.0.0

# File 'lib/kramdown/man.rb', line 23

def to_man(options={})
  output, warnings = Kramdown::Man::Converter.convert(@root,options)

  @warnings.concat(warnings)
  return output
end