kramdown 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7dfcfddc0bd28ea18be74a4f72d5a0f9549fdbfa
-  data.tar.gz: 419c886d8df8aa564eae484b89f3c7faceb259a7
+  metadata.gz: a8108b2bee2981647e49b9d9bab886babcc204fc
+  data.tar.gz: cc74805fdeda7a9756f98f9a16d6ec3ca17442c5
 SHA512:
-  metadata.gz: 93aba2d37108f5e0651d66ee8ac3361440616414fb48e88c80fe20bdc46b93d5f6a8e392800c6c00bfc91aaf473501cbfb246d4f63985f6fafa366e18af80529
-  data.tar.gz: b50d2da0703b9fabc8a81064ea019038d85bf8e61986b411bbec27af28024c53701dfa06126294f1ef1c3aa1dc175d699253f5d892c19fb8cacaa34ac56ddd24
+  metadata.gz: efc4e05dfd0cc980479e027bfe8aa362e0f25dc008198dbd1922a3c18eb5552fdee1f78e2587ed430618af34ef6ea53f757b9f3447a86ea6b537318ed0d1c7e2
+  data.tar.gz: a7294eefa4b979a6bfe307c340c6b00b537f44c04e46977b4f5dedd256326bc7e02089a23edeaf4942e5e1f889fde1c21e469fcfa55dd32bfa8f49f94aa19818

data/CONTRIBUTERS

@@ -1,6 +1,6 @@
   Count Name
 ======= ====
-    720 Thomas Leitner <t_leitner@gmx.at>
+    756 Thomas Leitner <t_leitner@gmx.at>
       6 Gioele Barabucci <gioele@svario.it>
       4 Ted Pak <powerpak006@gmail.com>
       4 Arne Brasseur <arne@arnebrasseur.net>
@@ -12,6 +12,7 @@
       2 Nathanael Jones <nathanael.jones@gmail.com>
       2 Jo Hund <jhund@clearcove.ca>
       2 Bran <m.versum@gmail.com>
+      1 winniehell <git@winniehell.de>
       1 utenmiki <utenmiki@gmail.com>
       1 Trevor Wennblom <trevor@well.com>
       1 tomykaira <tomykaira@gmail.com>
@@ -30,6 +31,7 @@
       1 Luca Barbato <luca.barbato@gmail.com>
       1 John Croisant <jacius@gmail.com>
       1 Joe Fiorini <joe@faithfulgeek.org>
+      1 Jens Kraemer <jk@jkraemer.net>
       1 Floreal Morandat florealm@gmail.com <florealm@gmail.com>
       1 Damien Pollet <damien.pollet@gmail.com>
       1 Alex Tomlins <alex.tomlins@digital.cabinet-office.gov.uk>

data/README.md

@@ -13,7 +13,7 @@ sidebar on the [kramdown homepage](http://kramdown.gettalong.org/)!
 
 ## Introduction
 
-kramdown is yet-another-markdown-parser but fast, pure Ruby, using a strict syntax definition and
+kramdown is a fast, pure Ruby Markdown superset converter, using a strict syntax definition and
 supporting several common extensions.
 
 The syntax definition for the kramdown syntax can be found in **doc/syntax.page** (or online at
@@ -21,11 +21,11 @@ The syntax definition for the kramdown syntax can be found in **doc/syntax.page*
 **doc/quickref.page** or online at <http://kramdown.gettalong.org/quickref.html>.
 
 The kramdown library is mainly written to support the kramdown-to-HTML conversion chain. However,
-due to its flexibility it supports other input and output formats as well. Here is a list of the
-supported formats:
+due to its flexibility (by creating an internal AST) it supports other input and output formats as
+well. Here is a list of the supported formats:
 
-* input formats: kramdown (a Markdown superset), Markdown, HTML
-* output formats: HTML, kramdown, LaTeX (and therefore PDF)
+* input formats: kramdown (a Markdown superset), Markdown, GFM, HTML
+* output formats: HTML, kramdown, LaTeX (and therefore PDF), PDF via Prawn
 
 All the documentation on the available input and output formats is available in the **doc/**
 directory and online at <http://kramdown.gettalong.org>.
@@ -37,7 +37,7 @@ number on the introduction of new features and the patch number on everything el
 
 ## Usage
 
-kramdown has a basic *Cloth API, so using kramdown is as easy as
+kramdown has a very simple API, so using kramdown is as easy as
 
 ```ruby
 require 'kramdown'

data/Rakefile

@@ -177,9 +177,9 @@ EOF
       s.default_executable = 'kramdown'
       s.add_development_dependency 'minitest', '~> 5.0'
       s.add_development_dependency 'coderay', '~> 1.0.0'
-      s.add_development_dependency 'rouge', '~> 1.7'
+      s.add_development_dependency 'rouge', '~> 1.8'
       s.add_development_dependency 'stringex', '~> 1.5.1'
-      s.add_development_dependency 'prawn', '~> 0.13'
+      s.add_development_dependency 'prawn', '~> 2.0'
       s.add_development_dependency 'ritex', '~> 1.0'
       s.add_development_dependency 'itextomml', '~> 1.5'
 
@@ -239,7 +239,7 @@ EOF
   COPYRIGHT=<<EOF
 #
 #--
-# Copyright (C) 2009-2013 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++

data/VERSION

@@ -1 +1 @@
-1.5.0
+1.6.0

data/bin/kramdown

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2013 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++

data/doc/default.template

@@ -3,7 +3,7 @@
   <head>
     <meta http-equiv="content-type" content="text/html; charset=utf-8" />
     <meta name="author" content="Thomas Leitner" />
-    <meta name="copyright" content="2009-2013 Thomas Leitner" />
+    <meta name="copyright" content="2009-2015 Thomas Leitner" />
     <meta name="description" content="kramdown is a fast, pure-Ruby Markdown-superset converter" />
     <meta name="keywords" content="ruby, kramdown, markdown, text markup" />
     <link href="{relocatable: default.css}" type="text/css" rel="stylesheet" media="screen,projection" />
@@ -43,7 +43,7 @@
     </div>
 
     <footer>
-      <div class="float-left">Copyright © 2009-2013 Thomas Leitner</div>
+      <div class="float-left">Copyright © 2009-2015 Thomas Leitner</div>
       <div class="float-right">Generated by <a href="http://webgen.gettalong.org">webgen</a></div>
     </footer>
 

data/doc/index.page

@@ -74,22 +74,36 @@ Markdown implementations because kramdown borrowed many ideas from existing pack
 * Thomas Leitner
 * e-Mail: <mailto:t_leitner@gmx.at>
 
-
 [PHP Markdown Extra]: http://michelf.com/projects/php-markdown/extra/
-[Maruku]:             http://maruku.rubyforge.org
-[BlueCloth]: http://www.deveiate.org/projects/BlueCloth
-
-
---- name:intro
+[Maruku]: http://maruku.rubyforge.org
+[BlueFeather]: http://ruby.morphball.net/bluefeather/index_en.html
 
-**kramdown** (sic, not Kramdown or KramDown, just kramdown) is a *free* MIT-licensed
+--- intro
+<div markdown="1" itemscope="" itemtype="http://schema.org/SoftwareApplication">
+<meta itemprop="applicationCategory" content="Markdown library, Markdown converter" />
+<meta itemprop="operatingSystem" content="Linux, Windows, Mac OS X" />
+<div itemprop="author" itemscope="" itemtype="http://schema.org/Person">
+<meta itemprop="name" content="Thomas Leitner" />
+<meta itemprop="email" content="t_leitner@gmx.at" />
+</div>
+
+**kramdown**{:itemprop="name"} (sic, not Kramdown or KramDown, just kramdown) is a *free*
+[MIT](https://github.com/gettalong/kramdown/blob/master/COPYING){:itemprop="license"}-licensed
 [Ruby](http://www.ruby-lang.org) library for parsing and converting a superset of Markdown. It is
 completely written in Ruby, supports standard Markdown (with some minor modifications) and various
 extensions that have been made popular by the [PHP Markdown Extra] package and [Maruku].
+{:itemprop="description"}
 
 It is probably the fastest pure-Ruby Markdown converter available (September 2014), being about 3x
 faster than [Maruku] and about 4.5x faster than [BlueFeather].
 
+Version **1.6.0**{:itemprop="softwareVersion"} released on
+**2015-02-28**{:itemprop="datePublished"}, [more news](news.html)
+{: style="text-align: center; font-size: 80%"}
+
+</div>
+
+
 [PHP Markdown Extra]: http://michelf.com/projects/php-markdown/extra/
 [Maruku]: http://maruku.rubyforge.org
 [BlueFeather]: http://ruby.morphball.net/bluefeather/index_en.html

data/doc/options.page

@@ -1,10 +1,49 @@
 ---
 title: Options
 ---
+## Options
+
+The behaviour of kramdown can be adjusted via the available options.
+
+Options can be specified in multiple ways:
+
+On the command line
+: The `kramdown` binary allows setting any option by using command line switches.
+
+  For example, the following command will disable automatic header ID generation and defines the
+  first footnote number as 5:
+
+  ~~~
+  $ kramdown --no-auto-ids --footnote-nr 5
+  ~~~
+
+  As you can see all underscores in option names have to be replaced with dashes. The built-in help
+  of the binary as well as the man-page show all available options.
+
+Within a kramdown document
+: By using the special extension syntax, it is possible to set options within a document.
+
+  Using the above example, the options would be set like this within a document:
+
+  ~~~
+  {::options auto_ids="false" footnote_nr="5" /}
+  ~~~
+
+Using Ruby code
+
+: If you are using kramdown as a library, you can pass any options as second parameter to the
+  `Kramdown::Document.new` method.
+
+  Again, using the above example you would initalize the kramdown document class as follows:
+
+  ~~~ ruby
+  Kramdown::Document.new(source_text, \{auto_ids: false, footnote_nr: 5})
+  ~~~
+
+
 ## Available Options
 
-The behaviour of kramdown can be adjusted via the available options. Below is a list of all
-currently available options. Have a look at the documentation of a converter or parser to see
-directly which options they support!
+Below is a list of all currently available options. Have a look at the documentation of a converter
+or parser to see directly which options they support!
 
 {options: {items: all}}

data/doc/sidebar.template

@@ -1,10 +1,3 @@
-<h2>News</h2>
-
-<p>The latest version of kramdown is <span class="inline-important">1.5.0</span> and it was released
-on <span class="inline-important">2014-10-25</span></p>
-
-<p>More <a href="{relocatable: news.html}">news</a>…</p>
-
 <h2>Support kramdown</h2>
 
 <p>If you like kramdown and would like to support it, you are welcome to make a small

data/doc/sitemap.sitemap

@@ -0,0 +1,5 @@
+---
+entries:
+  alcn: /**/*.html
+default_change_freq: monthly
+---

data/doc/syntax.page

@@ -1156,6 +1156,11 @@ Notes:
 
 * The link title may not contain its delimiters and may not be empty.
 
+* Additional link attributes can be added by using a [span IAL](#span-ials) after the inline link,
+  for example:
+
+      This is a [link](http://example.com){:hreflang="de"}
+
 ### Reference Links
 
 To create a reference style link, you need to surround the link text with square brackets (as with
@@ -1173,6 +1178,9 @@ second pair of square brackets, the link text is converted to a valid link ident
 all invalid characters and inserting spaces for line breaks. If there is a link definition found for
 the link identifier, a link will be created. Otherwise the text is not converted to a link.
 
+As with inline links, additional link attributes can be added by using a [span IAL](#span-ials)
+after the reference link.
+
 ### Link Definitions
 
 The link definition can be put anywhere in the document. It does not appear in the output. A link
@@ -1205,6 +1213,11 @@ you can escape the colon after the link identifier:
 
     [Room 100]: link_to_room_100.html
 
+Although link definitions are non-content block-level elements, [block IALs](#block-ials) can be
+used on them to specify additional attributes for the links:
+
+    [linkid]: http://example.com
+    {:hreflang="de"}
 
 ### Images
 
@@ -1218,8 +1231,16 @@ example:
     ![too](../images/other.png 'Title text'). Or ![here].
     With empty alt text ![](see.jpg)
 
-The link definition for images is exactly the same as the link definition for normal links.
+The link definition for images is exactly the same as the link definition for normal links. Since
+additional attributes can be added via span and block IALs, it is possible, for example, to specify
+image width and height:
 
+    Here is an inline ![smiley](smiley.png){:height="36px" width="36px"}.
+
+    And here is a referenced ![smile]
+
+    [smile]: smile.png
+    {: height="36px" width="36px"}
 
 ## Emphasis
 
@@ -1402,6 +1423,8 @@ referenced footnote definitions will be placed at the end of the kramdown docume
 footnote definitions are ignored. If more than one footnote definitions have the same footnote name,
 all footnote definitions but the last are ignored.
 
+Although footnote definitions are non-content block-level elements, [block IALs](#block-ials) can be
+used on them to attach attributes. How these attributes are used depends on the converter.
 
 ## Abbreviations
 
@@ -1422,15 +1445,20 @@ following structure:
 * then a colon and the full phrase of the abbreviation on one line (leading and trailing spaces are
   stripped from the full phrase).
 
-Later abbreviation definition for the same abbreviation override prior ones and it does not matter
+Later abbreviation definitions for the same abbreviation override prior ones and it does not matter
 where you put an abbreviation definition in a kramdown document. Empty definitions are also allowed.
 
+Although abbreviation definitions are non-content block-level elements, [block IALs](#block-ials)
+can be used on them to specify additional attributes.
+
 Here are some examples:
 
     This is some text not written in HTML but in another language!
 
     *[another language]: It's called Markdown
+
     *[HTML]: HyperTextMarkupLanguage
+    {:.mega-big}
 
 > Abbreviation definitions are, despite being described here, non-content block-level elements.
 {: .information}
@@ -1587,7 +1615,7 @@ These elements are used to attach attributes to another element.
 > the [Maruku] package.
 {: .markdown-difference}
 
-This block-level element is used to attach attributes to a block-level element. A block inline
+This block-level element is used to attach attributes to another block-level element. A block inline
 attribute list (block IAL) has the same structure as an [ALD](#attribute-list-definitions) except
 that the colon/reference name/colon part is replaced by a colon. A block IAL (or two or more block
 IALs) has to be put directly before or after the block-level element to which the attributes should

data/doc/virtual

@@ -9,3 +9,6 @@ rdoc/index.html:
 
 /options.en.html#option-math-engine:
   dest_path: options.html#option-math-engine
+
+/options.en.html#option-math-engine-opts:
+  dest_path: options.html#option-math-engine-opts

data/lib/kramdown.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++

data/lib/kramdown/compatibility.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++

data/lib/kramdown/converter.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++

data/lib/kramdown/converter/base.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
@@ -9,6 +9,7 @@
 
 require 'erb'
 require 'kramdown/utils'
+require 'kramdown/document'
 
 module Kramdown
 

data/lib/kramdown/converter/html.rb

@@ -1,14 +1,15 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
 #
 
-require 'rexml/parsers/baseparser'
-require 'kramdown/parser/html'
+require 'kramdown/parser'
+require 'kramdown/converter'
+require 'kramdown/utils'
 
 module Kramdown
 
@@ -321,7 +322,9 @@ module Kramdown
 
       def convert_abbreviation(el, indent)
         title = @root.options[:abbrev_defs][el.value]
-        format_as_span_html("abbr", {:title => (title.empty? ? nil : title)}, el.value)
+        attr = @root.options[:abbrev_attr][el.value].dup
+        attr['title'] = title unless title.empty?
+        format_as_span_html("abbr", attr, el.value)
       end
 
       def convert_root(el, indent)
@@ -372,7 +375,9 @@ module Kramdown
         toc.each do |level, id, children|
           li = Element.new(:li, nil, nil, {:level => level})
           li.children << Element.new(:p, nil, nil, {:transparent => true})
-          a = Element.new(:a, nil, {'href' => "##{id}"})
+          a = Element.new(:a, nil)
+          a.attr['href'] = "##{id}"
+          a.attr['id'] = "#{sections.attr['id']}-#{id}"
           a.children.concat(remove_footnotes(Marshal.load(Marshal.dump(children))))
           li.children.last.children << a
           li.children << Element.new(type)

data/lib/kramdown/converter/kramdown.rb

@@ -1,13 +1,14 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2014 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
 #
 
-require 'rexml/parsers/baseparser'
+require 'kramdown/converter'
+require 'kramdown/utils'
 
 module Kramdown
 
@@ -280,17 +281,17 @@ module Kramdown
                   end
           "[#{inner(el, opts)}][#{index}]"
         else
-          title = el.attr['title'].to_s.empty? ? '' : ' "' + el.attr['title'].gsub(/"/, "&quot;") + '"'
+          title = parse_title(el.attr['title'])
           "[#{inner(el, opts)}](#{el.attr['href']}#{title})"
         end
       end
 
       def convert_img(el, opts)
-        alt_text = el.attr['alt'].gsub(ESCAPED_CHAR_RE) { $1 ? "\\#{$1}" : $2 }
+        alt_text = el.attr['alt'].to_s.gsub(ESCAPED_CHAR_RE) { $1 ? "\\#{$1}" : $2 }
         if el.attr['src'].empty?
           "![#{alt_text}]()"
         else
-          title = (el.attr['title'] ? ' "' + el.attr['title'].gsub(/"/, "&quot;") + '"' : '')
+          title = parse_title(el.attr['title'])
           link = if el.attr['src'].count("()") > 0
                    "<#{el.attr['src']}>"
                  else
@@ -369,8 +370,8 @@ module Kramdown
         res = ''
         res << "\n\n" if @linkrefs.size > 0
         @linkrefs.each_with_index do |el, i|
-          title = el.attr['title']
-          res << "[#{i+1}]: #{el.attr['href']}#{title ? ' "' + title.gsub(/"/, "&quot;") + '"' : ''}\n"
+          title = parse_title(el.attr['title'])
+          res << "[#{i+1}]: #{el.attr['href']}#{title}\n"
         end
         res
       end
@@ -389,6 +390,7 @@ module Kramdown
         res = ''
         @root.options[:abbrev_defs].each do |name, text|
           res << "*[#{name}]: #{text}\n"
+          res << ial_for_element(Element.new(:unused, nil, @root.options[:abbrev_attr][name])).to_s << "\n\n"
         end
         res
       end
@@ -415,6 +417,10 @@ module Kramdown
         res.strip.empty? ? nil : "{:#{res}}"
       end
 
+      def parse_title(attr)
+        attr.to_s.empty? ? '' : ' "' + attr.gsub(/"/, '&quot;') + '"'
+      end
+
       # :startdoc:
 
     end