class Kramdown::Converter::Html
Converts a Kramdown::Document to HTML.
def self.convert(doc)
def self.convert(doc) new(doc).convert(doc.tree) end
def convert(el, indent = -2)
def convert(el, indent = -2) result = '' el.children.each do |inner_el| result << convert(inner_el, indent + 2) end send("convert_#{el.type}", el, result, indent) end
def convert_a(el, inner, indent)
def convert_a(el, inner, indent) "<a#{options_for_element(el)}>#{inner}</a>" end
def convert_blank(el, inner, indent)
def convert_blank(el, inner, indent) "\n" end
def convert_blockquote(el, inner, indent)
def convert_blockquote(el, inner, indent) "#{' '*indent}<blockquote#{options_for_element(el)}>\n#{inner}#{' '*indent}</blockquote>\n" end
def convert_br(el, inner, indent)
def convert_br(el, inner, indent) "<br />" end
def convert_codeblock(el, inner, indent)
def convert_codeblock(el, inner, indent) result = escape_html(el.value) if el.options[:attr] && el.options[:attr].has_key?('class') && el.options[:attr]['class'] =~ /\bshow-whitespaces\b/ result.gsub!(/(?:(^[ \t]+)|([ \t]+$)|([ \t]+))/) do |m| suffix = ($1 ? '-l' : ($2 ? '-r' : '')) m.scan(/./).map do |c| case c when "\t" then "<span class=\"ws-tab#{suffix}\">\t</span>" when " " then "<span class=\"ws-space#{suffix}\">⋅</span>" end end.join('') end end "#{' '*indent}<pre#{options_for_element(el)}><code>#{result}#{result =~ /\n\Z/ ? '' : "\n"}</code></pre>\n" end
def convert_codespan(el, inner, indent)
def convert_codespan(el, inner, indent) "<code#{options_for_element(el)}>#{escape_html(el.value)}</code>" end
def convert_dt(el, inner, indent)
def convert_dt(el, inner, indent) "#{' '*indent}<dt#{options_for_element(el)}>#{inner}</dt>\n" end
def convert_em(el, inner, indent)
def convert_em(el, inner, indent) "<#{el.type}#{options_for_element(el)}>#{inner}</#{el.type}>" end
def convert_entity(el, inner, indent)
def convert_entity(el, inner, indent) el.value end
def convert_eob(el, inner, indent)
def convert_eob(el, inner, indent) '' end
def convert_footnote(el, inner, indent)
def convert_footnote(el, inner, indent) number = @footnote_counter @footnote_counter += 1 @footnotes << [el.options[:name], @doc.parse_infos[:footnotes][el.options[:name]]] "<sup id=\"fnref:#{el.options[:name]}\"><a href=\"#fn:#{el.options[:name]}\" rel=\"footnote\">#{number}</a></sup>" end
def convert_header(el, inner, indent)
def convert_header(el, inner, indent) "#{' '*indent}<h#{el.options[:level]}#{options_for_element(el)}>#{inner}</h#{el.options[:level]}>\n" end
def convert_hr(el, inner, indent)
def convert_hr(el, inner, indent) "#{' '*indent}<hr />\n" end
def convert_html_element(el, inner, indent)
def convert_html_element(el, inner, indent) if @doc.options[:filter_html].include?(el.value) inner.chomp + (el.options[:type] == :block ? "\n" : '') elsif el.options[:type] == :span "<#{el.value}#{options_for_element(el)}" << (!inner.empty? ? ">#{inner}</#{el.value}>" : " />") else output = '' output << ' '*indent if !el.options[:no_start_indent] && el.options[:parse_type] != :raw && !el.options[:parent_is_raw] output << "<#{el.value}#{options_for_element(el)}" if !inner.empty? && (el.options[:compact] || el.options[:parse_type] != :block) output << ">#{inner}</#{el.value}>" elsif !inner.empty? && (el.children.first.type == :text || el.children.first.options[:no_start_indent]) output << ">#{inner}" << ' '*indent << "</#{el.value}>" elsif !inner.empty? output << ">\n#{inner}" << ' '*indent << "</#{el.value}>" elsif HTML_TAGS_WITH_BODY.include?(el.value) output << "></#{el.value}>" else output << " />" end output << "\n" if el.options[:outer_element] || (el.options[:parse_type] != :raw && !el.options[:parent_is_raw]) output end end
def convert_html_raw(el, inner, indent)
def convert_html_raw(el, inner, indent) el.value + (el.options[:type] == :block ? "\n" : '') end
def convert_img(el, inner, indent)
def convert_img(el, inner, indent) "<img#{options_for_element(el)} />" end
def convert_li(el, inner, indent)
def convert_li(el, inner, indent) output = ' '*indent << "<#{el.type}" << options_for_element(el) << ">" if el.options[:first_is_block] output << "\n" << inner << ' '*indent else output << inner << (inner =~ /\n\Z/ ? ' '*indent : '') end output << "</#{el.type}>\n" end
def convert_p(el, inner, indent)
def convert_p(el, inner, indent) "#{' '*indent}<p#{options_for_element(el)}>#{inner}</p>\n" end
def convert_raw(el, inner, indent)
def convert_raw(el, inner, indent) el.value end
def convert_root(el, inner, indent)
def convert_root(el, inner, indent) inner << footnote_content end
def convert_text(el, inner, indent)
def convert_text(el, inner, indent) escape_html(el.value, false) end
def convert_typographic_sym(el, inner, indent)
def convert_typographic_sym(el, inner, indent) TYPOGRAPHIC_SYMS[el.value] end
def convert_ul(el, inner, indent)
def convert_ul(el, inner, indent) "#{' '*indent}<#{el.type}#{options_for_element(el)}>\n#{inner}#{' '*indent}</#{el.type}>\n" end
def escape_html(str, all = true)
characters are escaped, if +all+ is +false+ then only those characters are escaped that are
Escape the special HTML characters in the string +str+. If +all+ is +true+ then all
def escape_html(str, all = true) str.gsub(all ? ESCAPE_ALL_RE : ESCAPE_ALL_NOT_ENTITIES_RE) {|m| ESCAPE_MAP[m] || m} end
def footnote_content
def footnote_content ol = Element.new(:ol) ol.options[:attr] = {'start' => @footnote_start} if @footnote_start != 1 @footnotes.each do |name, data| li = Element.new(:li, nil, {:attr => {:id => "fn:#{name}"}, :first_is_block => true}) li.children = Marshal.load(Marshal.dump(data[:content].children)) #TODO: probably remove this!!!! ol.children << li ref = Element.new(:raw, "<a href=\"#fnref:#{name}\" rev=\"footnote\">↩</a>") if li.children.last.type == :p para = li.children.last else li.children << (para = Element.new(:p)) end para.children << ref end (ol.children.empty? ? '' : "<div class=\"kramdown-footnotes\">\n#{convert(ol, 2)}</div>\n") end
def initialize(doc)
def initialize(doc) @doc = doc @footnote_counter = @footnote_start = @doc.options[:footnote_nr] @footnotes = [] end
def options_for_element(el)
def options_for_element(el) (el.options[:attr] || {}).map {|k,v| v.nil? ? '' : " #{k}=\"#{escape_html(v.to_s, false)}\"" }.sort.join('') end