Class: Qiita::Markdown::Processor

Inherits:

Object

• Object
• Qiita::Markdown::Processor

Defined in:

lib/qiita/markdown/processor.rb

Direct Known Subclasses

SummaryProcessor

Constant Summary

DEFAULT_CONTEXT =

{
  asset_root: "/images",
}

DEFAULT_FILTERS =

[
  Filters::Greenmat,
  Filters::Footnote,
  Filters::Code,
  Filters::Checkbox,
  HTML::Pipeline::EmojiFilter,
  Filters::SyntaxHighlight,
  Filters::Mention,
  Filters::Sanitize,
]

Instance Method Summary

• #call(input, context = {}) ⇒ Hash

  Converts Markdown text into HTML string with extracted metadata.

• #filters ⇒ Array<HTML::Pipeline::Filter>
• #initialize(context = {}) ⇒ Processor constructor

  A new instance of Processor.

Constructor Details

#initialize(context = {}) ⇒ Processor

Returns a new instance of Processor.

Parameters:

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

  Optional context for HTML::Pipeline.

# File 'lib/qiita/markdown/processor.rb', line 20

def initialize(context = {})
  @context = DEFAULT_CONTEXT.merge(context)
end

Instance Method Details

#call(input, context = {}) ⇒ Hash

Converts Markdown text into HTML string with extracted metadata.

Examples:

Qiita::Markdown::Processor.new.call(markdown) #=> {
  codes: [...],
  mentioned_usernames: [...],
  output: "...",
}

Parameters:

• input (String) —

  Markdown text.

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

  Optional context merged into default context.

Returns:

• (Hash) —

  Process result.

# File 'lib/qiita/markdown/processor.rb', line 35

def call(input, context = {})
  HTML::Pipeline.new(filters, @context).call(input, context)
end

#filters ⇒ Array<HTML::Pipeline::Filter>

Note:

Modify filters if you want.

Returns:

• (Array<HTML::Pipeline::Filter>)

# File 'lib/qiita/markdown/processor.rb', line 41

def filters
  @filters ||= DEFAULT_FILTERS
end