kramdown 2.1.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e43c55f31bbce7153d1d863ab7c90bb24aee7741e7df3a0f6d89064286fe2344
-  data.tar.gz: c53d7af0318896bae6bdcb9123eb714f9572e4c9918f04d093c7d228c2431b0e
+  metadata.gz: 3c41b216fbd6f50c68b10864bc3a98040f79641db9af8ced05eb43f7817335ad
+  data.tar.gz: ef3adb19cbfbe4586bf0ef4f14362ca843a7fe3331ff6dc990c270ff65cff000
 SHA512:
-  metadata.gz: 351a0939690de3cf44107f5cad613d8d3dc945b6d47d0e78f8bf676081b7887f696e738fb9200779a6821a870161a3110a7e42911e7705cc7d79af59ff061da6
-  data.tar.gz: dbd73556bc863c0d6a937705662909440fd1dea33415da9e98ac681e5cd33fbedde37a7311b1082c2bcd556aec2896c10ec1d203ca992783f05eae8e7572aea0
+  metadata.gz: 483e269f858aadd6bf8e7bf2f49ec90ddfdcd9628aec17822eb7eefcfc21897eb19d258a84b6291611a38a5958a79013c2c656d35f7740b116923bd8624a2329
+  data.tar.gz: 5ffeef35cdfb994411414d62bd8b5fcf09fcea7d926069896248148575b88b4abbfdc1e5aab6da8dbe6f97c3e0a4921b391802e391ea3c76a646be7f64fbbbda

data/CONTRIBUTERS

@@ -1,18 +1,20 @@
   Count Name
 ======= ====
-    913 Thomas Leitner <t_leitner@gmx.at>
+    964 Thomas Leitner <t_leitner@gmx.at>
+     18 Ashwin Maroli <ashmaroli@gmail.com>
       7 Christian Cornelssen <ccorn@1tein.de>
       6 Gioele Barabucci <gioele@svario.it>
+      5 Gleb Mazovetskiy <glex.spb@gmail.com>
       4 Ted Pak <powerpak006@gmail.com>
       4 Shuanglei Tao <tsl0922@gmail.com>
-      4 Gleb Mazovetskiy <glex.spb@gmail.com>
       4 Dan Allen <dan.j.allen@gmail.com>
-      4 Ashwin Maroli <ashmaroli@gmail.com>
       4 Arne Brasseur <arne@arnebrasseur.net>
       3 Henning Perl <perl@fast-sicher.de>
       3 gettalong <t_leitner@gmx.at>
+      3 Carsten Bormann <cabo@tzi.org>
       3 Brandur <brandur@mutelight.org>
       3 Ben Armston <ben.armston@googlemail.com>
+      3 Ashwin Maroli <ashmaroli@users.noreply.github.com>
       3 Alex Marandon <contact@alexmarandon.com>
       2 Tom Thorogood <me+github@tomthorogood.co.uk>
       2 Parker Moore <parkrmoore@gmail.com>
@@ -26,20 +28,28 @@
       1 utenmiki <utenmiki@gmail.com>
       1 Trevor Wennblom <trevor@well.com>
       1 tomykaira <tomykaira@gmail.com>
+      1 tom93 <tomlevy93@gmail.com>
+      1 Tobin Yehle <tobinyehle@gmail.com>
+      1 timcraft <mail@timcraft.com>
       1 Tim Blair <tim@bla.ir>
       1 Tim Besard <tim.besard@gmail.com>
       1 Tim Bates <tim@rumpuslabs.com>
       1 Sun Yaozhu <yzyzsun@gmail.com>
+      1 Stephen <stephengroat@users.noreply.github.com>
       1 Stephen Crosby <stevecrozz@gmail.com>
+      1 Stan Hu <stanhu@gmail.com>
       1 Simon Lydell <simon.lydell@gmail.com>
+      1 Simon Coffey <simon.coffey@futurelearn.com>
       1 Shusaku NAKAZATO <cu393uc@gmail.com>
       1 Sebastian Boehm <sebastian@sometimesfood.org>
       1 scherr <maximilianscherr@gmail.com>
       1 Postmodern <postmodern.mod3@gmail.com>
       1 Pete Michaud <michaudp@gmail.com>
+      1 Noah Doersing <doersino@gmail.com>
       1 myqlarson <myqlarson@gmail.com>
       1 milo.simpson <milo.simpson@bazaarvoice.com>
       1 Michal Till <michal.till@gmail.com>
+      1 Maxime Kjaer <maxime.kjaer@gmail.com>
       1 Matt Hickford <matt.hickford@gmail.com>
       1 Martyn Chamberlin <martyn@perfectioncoding.com>
       1 Marek Tuchowski <marek@tuchowski.com.pl>
@@ -56,13 +66,19 @@
       1 Hector Correa <hector@hectorcorrea.com>
       1 Florian Klampfer <f.klampfer@gmail.com>
       1 Floreal Morandat florealm@gmail.com <florealm@gmail.com>
+      1 Fangyi Zhou <me@fangyi.io>
       1 Diego Galeota <diegobg123@gmail.com>
+      1 David Rodríguez <deivid.rodriguez@riseup.net>
+      1 Daniel Bair <daniel@danielbair.com>
       1 Damien Pollet <damien.pollet@gmail.com>
       1 Christopher Jefferson <caj21@st-andrews.ac.uk>
       1 Cédric Boutillier <cedric.boutillier@gmail.com>
+      1 Bob Lail <lail@squareup.com>
       1 Ashe Connor <ashe@kivikakk.ee>
+      1 aschmitz <29508+aschmitz@users.noreply.github.com>
       1 Antoine Cotten <hello@acotten.com>
       1 Andrew <andrew.dale.wylie@gmail.com>
       1 Alpha Chen <alpha.chen@gmail.com>
       1 Alex Tomlins <alex.tomlins@digital.cabinet-office.gov.uk>
       1 Alexey Vasiliev <le0pard@users.noreply.github.com>
+      1 284km <k.furuhashi10@gmail.com>

data/README.md

@@ -7,8 +7,14 @@ requests it is now released under the MIT license and therefore can easily be us
 projects, too.
 
 However, if you use kramdown in a commercial setting, please consider **contributing back any
-changes** for the benefit of the community and/or
-[**becoming a patron**](https://www.patreon.com/gettalong) - thanks!
+changes** for the benefit of the community and/or [**becoming a
+sponsor**](https://github.com/sponsors/gettalong/) or [**a
+patron**](https://www.patreon.com/gettalong) - thanks!
+
+Sponsors:
+
+* **GROSSWEBER** provides <a href="http://grossweber.com/b/kramdown" target="_blank">software
+  development consulting and training services</a>.
 
 
 ## Introduction

data/VERSION

@@ -1 +1 @@
-2.1.0
+2.4.0

data/lib/kramdown/converter/base.rb

@@ -106,7 +106,8 @@ module Kramdown
         end
         result = converter.convert(tree)
         if result.respond_to?(:encode!) && result.encoding != Encoding::BINARY
-          result.encode!(tree.options[:encoding])
+          result.encode!(tree.options[:encoding] ||
+                         (raise ::Kramdown::Error, "Missing encoding option on root element"))
         end
         if !converter.options[:template].empty? && converter.apply_template_after?
           result = apply_template(converter, result)

data/lib/kramdown/converter/html.rb

@@ -46,15 +46,16 @@ module Kramdown
         @toc_code = nil
         @indent = 2
         @stack = []
-      end
 
-      # The mapping of element type to conversion method.
-      DISPATCHER = Hash.new {|h, k| h[k] = "convert_#{k}" }
+        # stash string representation of symbol to avoid allocations from multiple interpolations.
+        @highlighter_class = " highlighter-#{options[:syntax_highlighter]}"
+        @dispatcher = Hash.new {|h, k| h[k] = :"convert_#{k}" }
+      end
 
       # Dispatch the conversion of the element +el+ to a +convert_TYPE+ method using the +type+ of
       # the element.
       def convert(el, indent = -@indent)
-        send(DISPATCHER[el.type], el, indent)
+        send(@dispatcher[el.type], el, indent)
       end
 
       # Return the converted content of the children of +el+ as a string. The parameter +indent+ has
@@ -67,7 +68,7 @@ module Kramdown
         indent += @indent
         @stack.push(el)
         el.children.each do |inner_el|
-          result << send(DISPATCHER[inner_el.type], inner_el, indent)
+          result << send(@dispatcher[inner_el.type], inner_el, indent)
         end
         @stack.pop
         result
@@ -78,7 +79,8 @@ module Kramdown
       end
 
       def convert_text(el, _indent)
-        escape_html(el.value, :text)
+        escaped = escape_html(el.value, :text)
+        @options[:remove_line_breaks_for_cjk] ? fix_cjk_line_break(escaped) : escaped
       end
 
       def convert_p(el, indent)
@@ -86,21 +88,23 @@ module Kramdown
           inner(el, indent)
         elsif el.children.size == 1 && el.children.first.type == :img &&
             el.children.first.options[:ial]&.[](:refs)&.include?('standalone')
-          convert_standalone_image(el.children.first, indent)
+          convert_standalone_image(el, indent)
         else
-          format_as_block_html(el.type, el.attr, inner(el, indent), indent)
+          format_as_block_html("p", el.attr, inner(el, indent), indent)
         end
       end
 
       # Helper method used by +convert_p+ to convert a paragraph that only contains a single :img
       # element.
       def convert_standalone_image(el, indent)
-        attr = el.attr.dup
-        figure_attr = {}
-        figure_attr['class'] = attr.delete('class') if attr.key?('class')
-        figure_attr['id'] = attr.delete('id') if attr.key?('id')
-        body = "#{' ' * (indent + @indent)}<img#{html_attributes(attr)} />\n" \
-          "#{' ' * (indent + @indent)}<figcaption>#{attr['alt']}</figcaption>\n"
+        figure_attr = el.attr.dup
+        image_attr = el.children.first.attr.dup
+
+        figure_attr['class'] = image_attr.delete('class') if image_attr.key?('class') and not figure_attr.key?('class')
+        figure_attr['id'] = image_attr.delete('id') if image_attr.key?('id') and not figure_attr.key?('id')
+
+        body = "#{' ' * (indent + @indent)}<img#{html_attributes(image_attr)} />\n" \
+          "#{' ' * (indent + @indent)}<figcaption>#{image_attr['alt']}</figcaption>\n"
         format_as_indented_block_html("figure", figure_attr, body, indent)
       end
 
@@ -135,7 +139,7 @@ module Kramdown
       end
 
       def convert_blockquote(el, indent)
-        format_as_indented_block_html(el.type, el.attr, inner(el, indent), indent)
+        format_as_indented_block_html("blockquote", el.attr, inner(el, indent), indent)
       end
 
       def convert_header(el, indent)
@@ -152,12 +156,15 @@ module Kramdown
         "#{' ' * indent}<hr#{html_attributes(el.attr)} />\n"
       end
 
+      ZERO_TO_ONETWENTYEIGHT = (0..128).to_a.freeze
+      private_constant :ZERO_TO_ONETWENTYEIGHT
+
       def convert_ul(el, indent)
-        if !@toc_code && (el.options[:ial][:refs].include?('toc') rescue nil)
-          @toc_code = [el.type, el.attr, (0..128).to_a.map { rand(36).to_s(36) }.join]
+        if !@toc_code && el.options.dig(:ial, :refs)&.include?('toc')
+          @toc_code = [el.type, el.attr, ZERO_TO_ONETWENTYEIGHT.map { rand(36).to_s(36) }.join]
           @toc_code.last
-        elsif !@footnote_location && el.options[:ial] && (el.options[:ial][:refs] || []).include?('footnotes')
-          @footnote_location = (0..128).to_a.map { rand(36).to_s(36) }.join
+        elsif !@footnote_location && el.options.dig(:ial, :refs)&.include?('footnotes')
+          @footnote_location = ZERO_TO_ONETWENTYEIGHT.map { rand(36).to_s(36) }.join
         else
           format_as_indented_block_html(el.type, el.attr, inner(el, indent), indent)
         end
@@ -165,7 +172,7 @@ module Kramdown
       alias convert_ol convert_ul
 
       def convert_dl(el, indent)
-        format_as_indented_block_html(el.type, el.attr, inner(el, indent), indent)
+        format_as_indented_block_html("dl", el.attr, inner(el, indent), indent)
       end
 
       def convert_li(el, indent)
@@ -188,7 +195,7 @@ module Kramdown
             break
           end
         end if !attr['id'] && @stack.last.options[:ial] && @stack.last.options[:ial][:refs]
-        format_as_block_html(el.type, attr, inner(el, indent), indent)
+        format_as_block_html("dt", attr, inner(el, indent), indent)
       end
 
       def convert_html_element(el, indent)
@@ -263,7 +270,7 @@ module Kramdown
       end
 
       def convert_a(el, indent)
-        format_as_span_html(el.type, el.attr, inner(el, indent))
+        format_as_span_html("a", el.attr, inner(el, indent))
       end
 
       def convert_img(el, _indent)
@@ -276,7 +283,7 @@ module Kramdown
         hl_opts = {}
         result = highlight_code(el.value, lang, :span, hl_opts)
         if result
-          add_syntax_highlighter_to_class_attr(attr, hl_opts[:default_lang])
+          add_syntax_highlighter_to_class_attr(attr, lang || hl_opts[:default_lang])
         else
           result = escape_html(el.value)
         end
@@ -296,8 +303,8 @@ module Kramdown
           @footnotes << [name, el.value, number, 0]
           @footnotes_by_name[name] = @footnotes.last
         end
-        "<sup id=\"fnref:#{name}#{repeat}\">" \
-          "<a href=\"#fn:#{name}\" class=\"footnote\">" \
+        "<sup id=\"fnref:#{name}#{repeat}\" role=\"doc-noteref\">" \
+          "<a href=\"#fn:#{name}\" class=\"footnote\" rel=\"footnote\">" \
           "#{number}</a></sup>"
       end
 
@@ -400,7 +407,7 @@ module Kramdown
       # Add the syntax highlighter name to the 'class' attribute of the given attribute hash. And
       # overwrites or add a "language-LANG" part using the +lang+ parameter if +lang+ is not nil.
       def add_syntax_highlighter_to_class_attr(attr, lang = nil)
-        (attr['class'] = (attr['class'] || '') + " highlighter-#{@options[:syntax_highlighter]}").lstrip!
+        (attr['class'] = (attr['class'] || '') + @highlighter_class).lstrip!
         attr['class'].sub!(/\blanguage-\S+|(^)/) { "language-#{lang}#{$1 ? ' ' : ''}" } if lang
       end
 
@@ -475,9 +482,9 @@ module Kramdown
         result
       end
 
-      FOOTNOTE_BACKLINK_FMT = "%s<a href=\"#fnref:%s\" class=\"reversefootnote\">%s</a>"
+      FOOTNOTE_BACKLINK_FMT = "%s<a href=\"#fnref:%s\" class=\"reversefootnote\" role=\"doc-backlink\">%s</a>"
 
-      # Return a HTML ordered list with the footnote content for the used footnotes.
+      # Return an HTML ordered list with the footnote content for the used footnotes.
       def footnote_content
         ol = Element.new(:ol)
         ol.attr['start'] = @footnote_start if @footnote_start != 1
@@ -485,7 +492,7 @@ module Kramdown
         backlink_text = escape_html(@options[:footnote_backlink], :text)
         while i < @footnotes.length
           name, data, _, repeat = *@footnotes[i]
-          li = Element.new(:li, nil, 'id' => "fn:#{name}")
+          li = Element.new(:li, nil, 'id' => "fn:#{name}", 'role' => 'doc-endnote')
           li.children = Marshal.load(Marshal.dump(data.children))
 
           para = nil
@@ -520,7 +527,7 @@ module Kramdown
         if ol.children.empty?
           ''
         else
-          format_as_indented_block_html('div', {class: "footnotes"}, convert(ol, 2), 0)
+          format_as_indented_block_html('div', {class: "footnotes", role: "doc-endnotes"}, convert(ol, 2), 0)
         end
       end
 

data/lib/kramdown/converter/kramdown.rb

@@ -27,6 +27,8 @@ module Kramdown
         @footnotes = []
         @abbrevs = []
         @stack = []
+        @list_indent = @options[:list_indent]
+        @list_spacing = ' ' * (@list_indent - 2)
       end
 
       def convert(el, opts = {indent: 0})
@@ -34,13 +36,13 @@ module Kramdown
         res = res.dup if res.frozen?
         if ![:html_element, :li, :dt, :dd, :td].include?(el.type) && (ial = ial_for_element(el))
           res << ial
-          res << "\n\n" if Element.category(el) == :block
+          res << "\n\n" if el.block?
         elsif [:ul, :dl, :ol, :codeblock].include?(el.type) && opts[:next] &&
             ([el.type, :codeblock].include?(opts[:next].type) ||
              (opts[:next].type == :blank && opts[:nnext] &&
               [el.type, :codeblock].include?(opts[:nnext].type)))
           res << "^\n\n"
-        elsif Element.category(el) == :block &&
+        elsif el.block? &&
             ![:li, :dd, :dt, :td, :th, :tr, :thead, :tbody, :tfoot, :blank].include?(el.type) &&
             (el.type != :html_element || @stack.last.type != :html_element) &&
             (el.type != :p || !el.options[:transparent])
@@ -77,7 +79,9 @@ module Kramdown
         else
           el.value.gsub(/\A\n/) do
             opts[:prev] && opts[:prev].type == :br ? '' : "\n"
-          end.gsub(/\s+/, ' ').gsub(ESCAPED_CHAR_RE) { "\\#{$1 || $2}" }
+          end.gsub(/\s+/, ' ').gsub(ESCAPED_CHAR_RE) do
+            $1 || !opts[:prev] || opts[:prev].type == :br ? "\\#{$1 || $2}" : $&
+          end
         end
       end
 
@@ -87,6 +91,7 @@ module Kramdown
         first&.gsub!(/^(?:(#|>)|(\d+)\.|([+-]\s))/) { $1 || $3 ? "\\#{$1 || $3}" : "#{$2}\\." }
         second&.gsub!(/^([=-]+\s*?)$/, "\\\1")
         res = [first, second, *rest].compact.join("\n") + "\n"
+        res.gsub!(/^[ ]{0,3}:/, "\\:")
         if el.children.length == 1 && el.children.first.type == :math
           res = "\\#{res}"
         elsif res.start_with?('\$$') && res.end_with?("\\$$\n")
@@ -124,7 +129,7 @@ module Kramdown
 
       def convert_li(el, opts)
         sym, width = if @stack.last.type == :ul
-                       [+'* ', el.children.first && el.children.first.type == :codeblock ? 4 : 2]
+                       ['* ' + @list_spacing, el.children.first && el.children.first.type == :codeblock ? 4 : @list_indent]
                      else
                        ["#{opts[:index] + 1}.".ljust(4), 4]
                      end
@@ -151,7 +156,7 @@ module Kramdown
       end
 
       def convert_dd(el, opts)
-        sym, width = +": ", (el.children.first && el.children.first.type == :codeblock ? 4 : 2)
+        sym, width = ": " + @list_spacing, (el.children.first && el.children.first.type == :codeblock ? 4 : @list_indent)
         if (ial = ial_for_element(el))
           sym << ial << " "
         end
@@ -182,12 +187,17 @@ module Kramdown
         result << inner(el, opts) << "\n"
       end
 
-      HTML_TAGS_WITH_BODY = ['div', 'script', 'iframe', 'textarea']
+      HTML_TAGS_WITH_BODY = ['div', 'script', 'iframe', 'textarea', 'th', 'td']
+
+      HTML_ELEMENT_TYPES = [:entity, :text, :html_element].freeze
+      private_constant :HTML_ELEMENT_TYPES
 
       def convert_html_element(el, opts)
         markdown_attr = el.options[:category] == :block && el.children.any? do |c|
-          c.type != :html_element && (c.type != :p || !c.options[:transparent]) &&
-            Element.category(c) == :block
+          c.type != :html_element &&
+            (c.type != :p || !c.options[:transparent] ||
+             c.children.any? {|t| !HTML_ELEMENT_TYPES.member?(t.type) }) &&
+            c.block?
         end
         opts[:force_raw_text] = true if %w[script pre code].include?(el.value)
         opts[:raw_text] = opts[:force_raw_text] || opts[:block_raw_text] || \
@@ -421,9 +431,9 @@ module Kramdown
           end
         end.compact.join('')
         res = "toc" + (res.strip.empty? ? '' : " #{res}") if (el.type == :ul || el.type == :ol) &&
-          (el.options[:ial][:refs].include?('toc') rescue nil)
+          el.options.dig(:ial, :refs)&.include?('toc')
         res = "footnotes" + (res.strip.empty? ? '' : " #{res}") if (el.type == :ul || el.type == :ol) &&
-          (el.options[:ial][:refs].include?('footnotes') rescue nil)
+          el.options.dig(:ial, :refs)&.include?('footnotes')
         if el.type == :dl && el.options[:ial] && el.options[:ial][:refs]
           auto_ids = el.options[:ial][:refs].select {|ref| ref.start_with?('auto_ids') }.join(" ")
           res = auto_ids << (res.strip.empty? ? '' : " #{res}") unless auto_ids.empty?

data/lib/kramdown/converter/latex.rb

@@ -127,7 +127,7 @@ module Kramdown
       end
 
       def convert_ul(el, opts)
-        if !@data[:has_toc] && (el.options[:ial][:refs].include?('toc') rescue nil)
+        if !@data[:has_toc] && el.options.dig(:ial, :refs)&.include?('toc')
           @data[:has_toc] = true
           '\tableofcontents'
         else
@@ -517,7 +517,7 @@ module Kramdown
         8194 => ['\hskip .5em\relax'],
         8195 => ['\quad'],
       } # :nodoc:
-      ENTITY_CONV_TABLE.each_value {|v| v[0] = "{}#{v[0]}" }
+      ENTITY_CONV_TABLE.each_value {|v| v[0] = "#{v[0]}{}" }
 
       def entity_to_latex(entity)
         text, package = ENTITY_CONV_TABLE[entity.code_point]

data/lib/kramdown/converter/math_engine/mathjax.rb

@@ -16,40 +16,14 @@ module Kramdown::Converter::MathEngine
   module Mathjax
 
     def self.call(converter, el, opts)
-      type = el.options[:category]
-      text = (el.value =~ /<|&/ ? "% <![CDATA[\n#{el.value} %]]>" : el.value).dup
-      text.gsub!(/<\/?script>?/, '')
-
-      preview = preview_string(converter, el, opts).dup
-
-      attr = {type: "math/tex#{type == :block ? '; mode=display' : ''}"}
-      preview << if type == :block
-                   converter.format_as_block_html('script', attr, text, opts[:indent])
-                 else
-                   converter.format_as_span_html('script', attr, text)
-                 end
-    end
-
-    def self.preview_string(converter, el, opts)
-      preview = converter.options[:math_engine_opts][:preview]
-      return '' unless preview
-
-      preview = (preview == true ? converter.escape_html(el.value) : preview.to_s)
-
-      preview_as_code = converter.options[:math_engine_opts][:preview_as_code]
-
-      if el.options[:category] == :block
-        if preview_as_code
-          converter.format_as_block_html('pre', {'class' => 'MathJax_Preview'},
-                                         converter.format_as_span_html('code', {}, preview),
-                                         opts[:indent])
-        else
-          converter.format_as_block_html('div', {'class' => 'MathJax_Preview'}, preview,
-                                         opts[:indent])
-        end
+      value = converter.escape_html(el.value)
+      result = el.options[:category] == :block ?  "\\[#{value}\\]\n" : "\\(#{value}\\)"
+      if el.attr.empty?
+        result
+      elsif el.options[:category] == :block
+        converter.format_as_block_html('div', el.attr, result, opts[:indent])
       else
-        converter.format_as_span_html(preview_as_code ? 'code' : 'span',
-                                      {'class' => 'MathJax_Preview'}, preview)
+        converter.format_as_span_html('span', el.attr, "$#{el.value}$")
       end
     end
 

data/lib/kramdown/converter/syntax_highlighter/rouge.rb

@@ -45,24 +45,32 @@ module Kramdown::Converter::SyntaxHighlighter
       cache = converter.data[:syntax_highlighter_rouge] = {}
 
       opts = converter.options[:syntax_highlighter_opts].dup
-      span_opts = (opts.delete(:span) || {}).dup
-      block_opts = (opts.delete(:block) || {}).dup
-      [span_opts, block_opts].each do |hash|
-        hash.keys.each do |k|
-          hash[k.kind_of?(String) ? Kramdown::Options.str_to_sym(k) : k] = hash.delete(k)
-        end
-      end
 
-      cache[:span] = opts.merge(span_opts).update(wrap: false)
+      span_opts = opts.delete(:span)&.dup || {}
+      block_opts = opts.delete(:block)&.dup || {}
+      normalize_keys(span_opts)
+      normalize_keys(block_opts)
+
+      cache[:span] = opts.merge(span_opts)
+      cache[:span][:wrap] = false
+
       cache[:block] = opts.merge(block_opts)
     end
 
+    def self.normalize_keys(hash)
+      return if hash.empty?
+
+      hash.keys.each do |k|
+        hash[k.kind_of?(String) ? Kramdown::Options.str_to_sym(k) : k] = hash.delete(k)
+      end
+    end
+
     def self.formatter_class(opts = {})
       case formatter = opts[:formatter]
       when Class
         formatter
       when /\A[[:upper:]][[:alnum:]_]*\z/
-        ::Rouge::Formatters.const_get(formatter)
+        ::Rouge::Formatters.const_get(formatter, false)
       else
         # Available in Rouge 2.0 or later
         ::Rouge::Formatters::HTMLLegacy

data/lib/kramdown/converter/syntax_highlighter.rb

@@ -42,7 +42,7 @@ module Kramdown
     #
     # == Special Implementation Details
     #
-    # HTML converter:: If the syntax highlighter is used with a HTML converter, it should return
+    # HTML converter:: If the syntax highlighter is used with an HTML converter, it should return
     #                  :block type text correctly wrapped (i.e. normally inside a pre-tag, but may
     #                  also be a table-tag or just a div-tag) but :span type text *without* a
     #                  code-tag!

data/lib/kramdown/element.rb

@@ -14,6 +14,14 @@ module Kramdown
   # kramdown only uses this one class for representing all available elements in an element tree
   # (paragraphs, headers, emphasis, ...). The type of element can be set via the #type accessor.
   #
+  # The root of a kramdown element tree has to be an element of type :root. It needs to have certain
+  # option keys set so that conversions work correctly. If only a part of a tree should be
+  # converted, duplicate the root node and assign the #children appropriately, e.g:
+  #
+  #   root = doc.root
+  #   new_root = root.dup
+  #   new_root.children = [root.children[0]]  # assign new array with elements to convert
+  #
   # Following is a description of all supported element types.
   #
   # Note that the option :location may contain the start line number of an element in the source
@@ -522,6 +530,22 @@ module Kramdown
       CATEGORY[el.type] || el.options[:category]
     end
 
+    # syntactic sugar to simplify calls such as +Kramdown::Element.category(el) == :block+ with
+    # +el.block?+.
+    #
+    # Returns boolean true or false.
+    def block?
+      (CATEGORY[type] || options[:category]) == :block
+    end
+
+    # syntactic sugar to simplify calls such as +Kramdown::Element.category(el) == :span+ with
+    # +el.span?+.
+    #
+    # Returns boolean true or false.
+    def span?
+      (CATEGORY[type] || options[:category]) == :span
+    end
+
   end
 
 end