Class: Pandoku::Formats::Markdown

Inherits:
Pandoku::Format show all
Includes:
InputFormat, OutputFormat
Defined in:
lib/pandoku/formats/markdown.rb

Overview

Markdown format. daringfireball.net/projects/markdown/

Available Options

:strict

Use strict syntax, with no extensions or variants.

:reference_links

Use reference-style links, rather than inline links, in writing.

:smart

Use smart quotes, dashes, and ellipses.

:no_wrap

Disable text wrapping in output. (Default is to wrap text.)

:sanitize_html

Sanitizes HTML using a whitelist. Unsafe tags are replaced by HTML comments; unsafe attributes are omitted. URIs in links and images are also checked against a whitelist of URI schemes.

:toc

Include an automatically generated table of contents.

Instance Attribute Summary

Attributes inherited from Pandoku::Format

#options

Class Method Summary collapse

Methods included from InputFormat

#parse

Methods included from OutputFormat

#compile

Methods inherited from Pandoku::Format

#cliopts, inherited, #initialize

Constructor Details

This class inherits a constructor from Pandoku::Format

Class Method Details

.default_options ⇒ Object 



26
27
28
29
 
# File 'lib/pandoku/formats/markdown.rb', line 26

def self.default_options
  { :strict => false, :reference_links => false, :smart => false,
    :no_wrap => false, :sanitize_html => false, :toc => false }
end

.name ⇒ Object 



22
23
24
 
# File 'lib/pandoku/formats/markdown.rb', line 22

def self.name
  :markdown
end