kramdown 0.14.2 → 2.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2a893196013756c877e4baa3d62eb2d3b862684748ed4f329a9723779e30bbeb
+  data.tar.gz: abfac14092805a87a5bdb0c7210ddb157b35a22391a8393a8401fdc547d2f902
+SHA512:
+  metadata.gz: 2fdb47e22271964a0a5caef5dc9054a6a5d50cfd81c01665ddfe9aa8e66539ce97125019bea46700ff54227602ce45fd3af98bd48824fe3460aefd6ce6ec3828
+  data.tar.gz: 9927a0d0fe778ac799dcd499727623c7bb35cc2a46a5745042c88d65685502d7bc04384c265155af214f046a2a27f72cf4b73b2d3ddba6a987de85939b6cfe56

data/CONTRIBUTERS

@@ -1,16 +1,78 @@
   Count Name
 ======= ====
-    553 Thomas Leitner <t_leitner@gmx.at>
+    943 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 Dan Allen <dan.j.allen@gmail.com>
+      4 Arne Brasseur <arne@arnebrasseur.net>
+      3 Henning Perl <perl@fast-sicher.de>
       3 gettalong <t_leitner@gmx.at>
+      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>
+      2 Nathanael Jones <nathanael.jones@gmail.com>
+      2 Max Meyer <dev@fedux.org>
+      2 Jo Hund <jhund@clearcove.ca>
       2 Bran <m.versum@gmail.com>
+      1 winniehell <git@winniehell.de>
+      1 William <suttonwilliamd@gmail.com>
+      1 Uwe Kubosch <donv@users.noreply.github.com>
+      1 utenmiki <utenmiki@gmail.com>
+      1 Trevor Wennblom <trevor@well.com>
       1 tomykaira <tomykaira@gmail.com>
+      1 tom93 <tomlevy93@gmail.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 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>
+      1 Marcus Stollsteimer <sto.mar@web.de>
+      1 Luca Barbato <luca.barbato@gmail.com>
+      1 l3kn <hello@l3kn.de>
+      1 Kir Kolyshkin <kolyshkin@gmail.com>
+      1 Jun Aruga <jaruga@redhat.com>
+      1 Jonathan Hooper <jonathan.hooper@gsa.gov>
       1 John Croisant <jacius@gmail.com>
       1 Joe Fiorini <joe@faithfulgeek.org>
+      1 Jens Kraemer <jk@jkraemer.net>
+      1 Hirofumi Wakasugi <baenej@gmail.com>
+      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 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 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/COPYING

@@ -1,18 +1,24 @@
 kramdown - fast, pure-Ruby Markdown-superset converter
-Copyright (C) 2009 Thomas Leitner <t_leitner@gmx.at>
+Copyright (C) 2009-2013 Thomas Leitner <t_leitner@gmx.at>
 
-kramdown is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
 
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
 
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 
 Some test cases and the benchmark files are based on test cases from

data/README.md

@@ -1,28 +1,46 @@
 # kramdown
 
+## Readme first!
+
+kramdown was originally licensed under the GPL until the 1.0.0 release. However, due to the many
+requests it is now released under the MIT license and therefore can easily be used in commercial
+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!
+
+
 ## 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
-<http://kramdown.rubyforge.org/syntax.html>) and a quick reference is available in
-**doc/quickref.page** or online at <http://kramdown.rubyforge.org/quickref.html>.
+<http://kramdown.gettalong.org/syntax.html>) and a quick reference is available in
+**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.rubyforge.org>.
+directory and online at <http://kramdown.gettalong.org>.
+
+Starting from version 1.0.0 kramdown is using a versioning scheme with major, minor and patch parts
+in the version number where the major number changes on backwards-incompatible changes, the minor
+number on the introduction of new features and the patch number on everything else.
+
+For information about changes between versions, have a look at
+<http://kramdown.gettalong.org/news.html> or the commit history!
 
 
 ## 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'
@@ -32,19 +50,22 @@ Kramdown::Document.new(text).to_html
 
 For detailed information have a look at the API documentation of the `Kramdown::Document` class.
 
-The full API documentation is available at <http://kramdown.rubyforge.org/rdoc/>, other sites with an
+The full API documentation is available at <http://kramdown.gettalong.org/rdoc/>, other sites with an
 API documentation for kramdown probably don't provide the complete documentation!
 
+There are also some third-party libraries that extend the functionality of kramdown -- see the
+kramdown Wiki at <https://github.com/gettalong/kramdown/wiki>.
+
 
 ## Development
 
 Just clone the git repository as described in **doc/installation.page** and you are good to go. You
-probably want to install `rake` so that you can use the provided rake tasks. Aside from that:
+probably want to install `rake` so that you can use the provided rake tasks.
 
-* The `tidy` binary needs to be installed for the automatically derived tests to work.
-* The `latex` binary needs to be installed for the latex-compilation tests to work.
+If you want to run the tests, the development dependencies are needed as well as some additional
+programs like `tidy` and `latex`. See the `.travis.yml` file for more information.
 
 
 ## License
 
-GPLv3 - see the **COPYING** file.
+MIT - see the **COPYING** file.

data/VERSION

@@ -1 +1 @@
-0.14.2
+2.3.0

data/bin/kramdown

@@ -2,41 +2,100 @@
 # -*- coding: utf-8 -*-
 #
 #--
-# Copyright (C) 2009-2012 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
-# This file is part of kramdown.
-#
-# kramdown is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# This file is part of kramdown which is licensed under the MIT.
 #++
 #
 
 require 'optparse'
+require 'rbconfig'
+require 'yaml'
 require 'kramdown'
 
+def add_kramdown_options(opts, parsed_options, banner: [], ignore: [])
+  banner_shown = false
+  defined_options = []
+  Kramdown::Options.definitions.sort.each do |n, definition|
+    next if ignore.include?(n)
+
+    unless banner_shown
+      opts.separator("")
+      banner.each {|part| opts.separator(part) }
+      opts.separator("")
+      banner_shown = true
+    end
+
+    defined_options << n
+    no = n.to_s.tr('_', '-')
+    if definition.type == Kramdown::Options::Boolean
+      opts.on("--[no-]#{no}") {|v| parsed_options[n] = Kramdown::Options.parse(n, v) }
+    else
+      type = definition.type
+      type = String if type == Symbol || type == Object
+      opts.on("--#{no} ARG", type) {|v| parsed_options[n] = Kramdown::Options.parse(n, v) }
+    end
+
+    definition.desc.split(/\n/).each do |line|
+      opts.separator opts.summary_indent + ' ' * 6 + line
+    end
+    opts.separator ''
+  end
+  defined_options
+end
+
+config_file = nil
+begin
+  config_dir = case RbConfig::CONFIG['host_os']
+               when /bccwin|cygwin|djgpp|mingw|mswin|wince/i
+                 File.expand_path((ENV['HOME'] || ENV['USERPROFILE'] || "~") + "/AppData/Local")
+               when /darwin|mac os/
+                 File.expand_path("~/Library/Preferences/")
+               else
+                 File.expand_path(ENV['XDG_CONFIG_HOME'] || '~/.config')
+               end
+  config_file = File.join(config_dir, "kramdownrc")
+rescue StandardError
+end
+
 options = {}
 format = ['html']
+
+defined_options = []
 OptionParser.new do |opts|
   opts.banner = "Usage: kramdown [options] [FILE FILE ...]"
-  opts.summary_indent = ' '*4
+  opts.summary_indent = ' ' * 4
 
   opts.separator ""
   opts.separator "Command line options:"
   opts.separator ""
 
-  opts.on("-i", "--input ARG", "Specify the input format: kramdown (default) or html") {|v| options[:input] = v}
-  opts.on("-o", "--output ARG", Array, "Specify one or more output formats separated by commas: html (default), kramdown, latex or remove_html_tags") {|v| format = v}
-
+  opts.on("-i", "--input ARG", "Specify the input format: kramdown (default), " \
+          "html, or markdown") {|v| options[:input] = v }
+  opts.on("-o", "--output ARG", Array, "Specify one or more output formats separated by commas: " \
+          "html (default),", "kramdown, latex, man or remove_html_tags") {|v| format = v }
+  opts.on("-x", "--extension EXT", Array, "Load one or more extensions (without the 'kramdown-' " \
+          "prefix) separated", "by commas (e.g. parser-gfm,syntax-coderay)",
+          "Note: Use this option before other options!") do |exts|
+    exts.each do |ext|
+      begin
+        require "kramdown-#{ext}"
+        new_options = add_kramdown_options(opts, options, banner: ["#{ext} options:"],
+                                           ignore: defined_options)
+        defined_options.concat(new_options)
+      rescue LoadError
+        $stderr.puts "Couldn't load extension #{ext}, ignoring"
+      end
+    end
+  end
+  opts.separator ""
+  opts.on("--no-config-file", "Do not read any configuration file. Default behavior is to check " \
+          "for a", "configuration file and read it if it exists.") { config_file = nil }
+  opts.on("--config-file FILE", "Specify the name of a configuration file with kramdown options " \
+          "in YAML", "format, e.g. \"auto_id_prefix: ARG\" instead of \"--auto-id-prefix ARG\"",
+          "and \"auto_ids: false\" instead of \"--no-auto-ids\".",
+          "Default: #{config_file}") {|v| config_file = v }
+  opts.separator ""
   opts.on("-v", "--version", "Show the version of kramdown") do
     puts Kramdown::VERSION
     exit
@@ -46,34 +105,27 @@ OptionParser.new do |opts|
     exit
   end
 
-  opts.separator ""
-  opts.separator "kramdown options:"
-  opts.separator ""
+  new_options = add_kramdown_options(opts, options, banner: ["kramdown options:"])
+  defined_options.concat(new_options)
+end.parse!
 
-  Kramdown::Options.definitions.each do |n, definition|
-    no = n.to_s.tr('_', '-')
-    if definition.type == Kramdown::Options::Boolean
-      opts.on("--[no-]#{no}") {|v| options[n] = Kramdown::Options.parse(n, v)}
+begin
+  if config_file && File.exist?(config_file)
+    config_file_options = YAML.safe_load(File.read(config_file), [Symbol])
+    case config_file_options
+    when nil # empty configuration file except perhaps YAML header and comments
+      # Nothing to do
+    when Hash
+      options = config_file_options.merge(options)
     else
-      type = definition.type
-      type = String if type == Symbol || type == Object
-      opts.on("--#{no} ARG", type) {|v| options[n] = Kramdown::Options.parse(n, v)}
-    end
-
-    definition.desc.split(/\n/).each do |line|
-      opts.separator opts.summary_indent + ' '*6 + line
+      raise Kramdown::Error, "No YAML map in configuration file \"#{config_file}\""
     end
-    opts.separator ''
   end
-
-end.parse!
-
-begin
   doc = Kramdown::Document.new(ARGF.read, options)
   result = ''
-  format.each {|f| result = doc.send("to_#{f}")}
+  format.each {|f| result = doc.send("to_#{f}") }
   puts result
-  doc.warnings.each {|warn| $stderr.puts "Warning: #{warn}"}
+  doc.warnings.each {|warn| $stderr.puts "Warning: #{warn}" }
 rescue Kramdown::Error => e
   $stderr.puts "Error: #{e.message}"
   exit(1)

data/data/kramdown/document.html

@@ -1,5 +1,9 @@
+<!DOCTYPE html>
 <html>
   <head>
+    <% if @converter.root.options[:encoding] %>
+    <meta http-equiv="Content-type" content="text/html;charset=<%= @converter.root.options[:encoding] %>">
+    <% end %>
 <%
 extend ::Kramdown::Utils::Html
 title = ''

data/data/kramdown/document.latex

@@ -36,6 +36,13 @@ encmap = {
 \VerbatimFootnotes
 <% end %>
 
+<% if @converter.data[:packages].include?('acronym') %>
+<%   @converter.root.options[:abbrev_defs].each_pair do |k,v| %>\acrodef{<%= @converter.normalize_abbreviation_key(k) %>}[<%= k %>]{<%= @converter.escape(v) %>}
+<%   end %>
+<% end %>
+
+\setcounter{footnote}{<%= @converter.options[:footnote_nr] - 1 %>}
+
 \hypersetup{colorlinks=true,urlcolor=blue}
 
 \begin{document}

data/lib/kramdown.rb

@@ -1,22 +1,9 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8; frozen_string_literal: true -*-
 #
 #--
-# Copyright (C) 2009-2012 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
-# This file is part of kramdown.
-#
-# kramdown is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# This file is part of kramdown which is licensed under the MIT.
 #++
 #
 

data/lib/kramdown/converter.rb

@@ -1,25 +1,14 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8; frozen_string_literal: true -*-
 #
 #--
-# Copyright (C) 2009-2012 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
-# This file is part of kramdown.
-#
-# kramdown is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# This file is part of kramdown which is licensed under the MIT.
 #++
 #
 
+require 'kramdown/utils'
+
 module Kramdown
 
   # This module contains all available converters, i.e. classes that take a root Element and convert
@@ -36,6 +25,43 @@ module Kramdown
     autoload :Kramdown, 'kramdown/converter/kramdown'
     autoload :Toc, 'kramdown/converter/toc'
     autoload :RemoveHtmlTags, 'kramdown/converter/remove_html_tags'
+    autoload :HashAST, 'kramdown/converter/hash_ast'
+    autoload :HashAst, 'kramdown/converter/hash_ast'
+    autoload :Man, 'kramdown/converter/man'
+
+    extend ::Kramdown::Utils::Configurable
+
+    configurable(:syntax_highlighter)
+
+    ['Minted', "Rouge"].each do |klass_name|
+      kn_down = klass_name.downcase.intern
+      add_syntax_highlighter(kn_down) do |converter, text, lang, type, opts|
+        require "kramdown/converter/syntax_highlighter/#{kn_down}"
+        klass = ::Kramdown::Utils.deep_const_get("::Kramdown::Converter::SyntaxHighlighter::#{klass_name}")
+        if !klass.const_defined?(:AVAILABLE) || klass::AVAILABLE
+          add_syntax_highlighter(kn_down, klass)
+        else
+          add_syntax_highlighter(kn_down) { nil }
+        end
+        syntax_highlighter(kn_down).call(converter, text, lang, type, opts)
+      end
+    end
+
+    configurable(:math_engine)
+
+    ["Mathjax"].each do |klass_name|
+      kn_down = klass_name.downcase.intern
+      add_math_engine(kn_down) do |converter, el, opts|
+        require "kramdown/converter/math_engine/#{kn_down}"
+        klass = ::Kramdown::Utils.deep_const_get("::Kramdown::Converter::MathEngine::#{klass_name}")
+        if !klass.const_defined?(:AVAILABLE) || klass::AVAILABLE
+          add_math_engine(kn_down, klass)
+        else
+          add_math_engine(kn_down) { nil }
+        end
+        math_engine(kn_down).call(converter, el, opts)
+      end
+    end
 
   end