module Markdpwn::Dpwn

markdpwn is a clone of gfm (Git-Flavored Markdown).

Public Class Methods

accepts?(options) click to toggle source

Checks if some file should be formatted using Markdpwn. @param [Hash] options file properties considered in the decision process @option options [String] :mime_type the MIME type of the code file; e-mail

attachments and git blobs have MIME types

@option options [String] :file_name the name of the file containing the

piece of code; meaningful for files in version control repositories,
e-mail attachments, and code fetched from links

@return [Boolean] true if the given file is suitable for Markdpwn, false

otherwise
# File lib/markdpwn/dpwn.rb, line 36
def self.accepts?(options)
  return unless file_name = options[:file_name]
  ext = File.extname file_name
  ['.markdown', '.md'].include? ext
end
render(text, options = {}) click to toggle source

Marks up text using markdpwn.

The caller is responsible for making sure that the text can be rendered using markdpwn.

@param [String] text the text to be formatted using Markdpwn @param [Hash] options rendering options (currently ignored) @return [String] a HTML fragment containing the formatted text

# File lib/markdpwn/dpwn.rb, line 15
def self.render(text, options = {})
  renderer = Markdpwn::RedCarpetRenderer.new
  md = Redcarpet::Markdown.new renderer,
      autolink: true,
      no_intra_emphasis: true,
      tables: true,
      fenced_code_blocks: true,
      strikethrough: true,
      space_after_headers: true
  md.render text
end