kramdown 1.17.0 → 2.0.0.beta1

data/doc/installation.page

@@ -1,88 +0,0 @@
----
-title: Installation
-in_menu: true
-sort_info: 5
----
-# Download & Installation
-
-## Dependencies
-
-Since kramdown is written in Ruby, you just need the [Ruby interpreter](http://www.ruby-lang.org),
-version 2.x. There are no other dependencies.
-
-
-## Compatibility Notes
-
-kramdown should work on any platform which supports Ruby. It has been successfully tested on the
-following platforms:
-
-* Linux with Ruby 2.x and jruby 9.0.0.0.
-
-See the platform specific installation notes for more information!
-
-
-## Platform Specific Installation Instructions
-
-### Linux
-
-You need to make sure that Ruby is installed. If it isn't, consult the documentation of the Linux
-distribution you are using on how to install it. For example, in case of Ubuntu 17.10 (this should
-probably also work for any newer Ubuntu version or any recent Debian based distribution) all you
-need to do is:
-
-    sudo apt-get install ruby
-
-Once you have Ruby installed, you need to execute the following command to install kramdown:
-
-    sudo gem install kramdown
-
-
-### Mac OS X
-
-Mac OS X Snow Leopard comes with Ruby and Rubygems preinstalled. So installing kramdown is as easy
-as running:
-
-    sudo gem install kramdown
-
-
-### Windows
-
-You need to install Ruby first. This can easily be done by using the [RubyInstaller] - just download
-the installation binary and run it. After that open a command shell (select `Start -> Run...`, then
-enter `cmd` and click on `Ok`) and type in the following:
-
-    gem install kramdown
-
-[RubyInstaller]: http://rubyinstaller.org
-
-
-## Generic Installation Instructions
-
-
-### Using Rubygems
-
-If you are using Rubygems, installing the latest version of kramdown is as simple as executing
-
-    gem install kramdown
-
-
-### Manual Installation
-
-The latest version of kramdown can always be downloaded as `.tar.gz` or `.zip` via the [Github
-releases page][ghreleases]. After the download the package needs to be decompressed and then you can
-install kramdown using the included `setup.rb` installation method:
-
-    $ ruby setup.rb config
-    $ ruby setup.rb setup
-    $ ruby setup.rb install
-
-[ghreleases]: https://github.com/gettalong/kramdown/releases
-
-
-### Using the repository version
-
-kramdown uses git as its versioning system and kramdown's repository is hosted on GitHub. The
-repository always contains a clean state of the current development version of kramdown. To check
-out kramdown use the following command:
-
-     git clone git://github.com/gettalong/kramdown.git

data/doc/links.markdown

@@ -1,6 +0,0 @@
-[Maruku]: http://maruku.rubyforge.org
-[PHP Markdown Extra]: http://michelf.com/projects/php-markdown/extra/
-[Pandoc]: http://johnmacfarlane.net/pandoc/
-[MathJax]: http://www.mathjax.org
-[BlueCloth]: http://deveiate.org/projects/BlueCloth
-[RedCloth]: http://redcloth.org/

data/doc/metainfo

@@ -1,13 +0,0 @@
---- paths
-[/**/*.js, /**/*.css]:
-  modified_at_in_dest_path: true
-
-/**/*.scss:
-  modified_at_in_dest_path: true
-
---- alcn
-[converter/*.html, parser/*.html, documentation.en.html, options.en.html, tests.en.html]:
-  template: ../documentation.template
-
-/**/*.css:
-  pipeline: scss,cssminify

data/doc/news.feed

@@ -1,9 +0,0 @@
----
-title: kramdown News
-description: kramdown - a fast, pure Ruby Markdown-superset converter
-author: Thomas Leitner
-author_url: https://kramdown.gettalong.org
-entries: {alcn: news/*.html, sort: sort_info, reverse: true, limit: 10}
-versions:
-  atom:
-

data/doc/news.page

@@ -1,29 +0,0 @@
----
-title: News
-in_menu: false
-sort_info: 30
---- pipeline:tags,blocks,fragments
-
-<h1>News</h1>
-
-<a href="{relocatable: news.atom}">Atom-Feed</a>
-
-<webgen:block name="newsdata" node="current" />
-
---- name:newsdata pipeline:erb
-<%
-opts = {:alcn => '/news/*.html', :sort => 'sort_info', :reverse => true, :flatten => true}
-context.website.ext.item_tracker.add(context.dest_node, :nodes, :node_finder_option_set,
-  {:opts => opts, :ref_alcn => context.node.alcn}, :content)
-context.website.ext.node_finder.find(opts, context.node).each do |node|
- # context.options['contentprocessor.kramdown.options'] = {:auto_id_prefix => node.lcn.tr('.', '-')}
-%>
-
-<div class='news-item'>
-<div class="news-date float-right">
-  Published on <%= node['created_at'].strftime("%A, %d %B %Y") %>
-</div>
-<%= context.render_block(:name => 'content', :chain => [node]) %>
-</div>
-
-<% end %>

data/doc/options.page

@@ -1,49 +0,0 @@
----
-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
-
-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/quickref.page

@@ -1,603 +0,0 @@
----
-title: Quick Reference
-in_menu: true
-sort_info: 9
---- name:sidebar
-<div style="text-align: right">
-<a href="https://www.patreon.com/bePatron?u=4908963" class="patreon">Become a Patron!</a>
-</div>
-
-<h1>Contents</h1>
-
-{menu: {options: {descendants: true, levels: [2,6]}}}
---- name:content
-# Quick Reference
-
-Below are examples of all available structural elements that can be used in a kramdown text. Since
-the kramdown syntax is a superset of the Markdown syntax, only a small part of the available syntax
-is not available in standard Markdown syntax. Note, that only the most basic syntax information is
-given. However, a link to the detailed syntax for each element is provided (which also details the
-differences to the standard Markdown syntax). The quick reference is for version **<%=
-::Kramdown::VERSION %>** of the syntax documentation.
-
-kramdown has two main classes of elements: block and span-level elements. Block-level elements are
-used to create paragraphs, headers, lists and so on whereas span-level elements are used to markup
-text phrases as emphasized, as a link and so on.
-
-All examples below feature the kramdown source, the converted HTML source (shown when hovering over
-the kramdown source) and the output as it appears in the browser. This looks like this:
-
-<table class="kdexample">
-<tr>
-<td><pre class="kdexample-before"><code>kramdown example code</code></pre></td>
-<td><pre class="kdexample-after-source"><code>Example code converted to HTML</code></pre>
-<div class="kdexample-after-live" style="clear:none">
-Live browser view of example code
-</div>
-</td>
-</tr>
-</table>
-
-
-# Block-level Elements - Main Structural Elements
-
-## Paragraphs
-
-{kdlink: {oid: paragraphs, part: "paragraphs"}}
-
-Consecutive lines of text are considered to be one paragraph. As with other block level elements you
-have to add a blank line to separate it from the following block-level element:
-
-{kdexample::}
-The first paragraph.
-
-Another paragraph
-{kdexample}
-
-Explicit line breaks in a paragraph can be made by using two spaces or two backslashes at the end of a line:
-
-{kdexample::}
-This is a paragraph  
-which contains a hard line break.
-{kdexample}
-
-
-## Headers
-
-{kdlink: {oid: headers, part: "headers"}}
-
-kramdown supports Setext style headers and atx style headers. A header must always be preceded by a
-blank line except at the beginning of the document:
-
-
-{kdexample::}
-First level header
-==================
-
-Second level header
--------------------
-{kdexample}
-
-{kdexample::}
-# H1 header
-
-## H2 header
-
-### H3 header
-
-#### H4 header
-
-##### H5 header
-
-###### H6 header
-{kdexample}
-
-If you set the option `auto_ids` to `false` (for example, by using the `options` extension, see
-[Extensions](#extensions)), then the automatic header ID generation is turned off:
-
-{kdexample::}
-{::options auto_ids="false" /}
-
-# A header without an ID
-{kdexample}
-
-
-## Blockquotes
-
-{kdlink: {oid: blockquotes, part: "blockquotes"}}
-
-A blockquote is started using the `>` marker followed by an optional space; all following lines that
-are also started with the blockquote marker belong to the blockquote. You can use any block-level
-elements inside a blockquote:
-
-{kdexample::}
-> A sample blockquote.
->
-> >Nested blockquotes are
-> >also possible.
->
-> ## Headers work too
-> This is the outer quote again.
-{kdexample}
-
-You may also be lazy with the `>` markers as long as there is no blank line:
-
-{kdexample::}
-> This is a blockquote
-continued on this
-and this line.
-
-But this is a separate paragraph.
-{kdexample}
-
-## Code Blocks
-
-{kdlink: {oid: code-blocks, part: "code blocks"}}
-
-kramdown supports two different code block styles. One uses lines indented with either four spaces
-or one tab whereas the other uses lines with tilde characters as delimiters -- therefore the content
-does not need to be indented:
-
-{kdexample::}
-    This is a sample code block.
-
-    Continued here.
-{kdexample}
-
-{kdexample::}
-~~~~~~
-This is also a code block.
-~~~
-Ending lines must have at least as
-many tildes as the starting line.
-~~~~~~~~~~~~
-{kdexample}
-
-The following is a code block with a language specified:
-
-{kdexample::}
-~~~ ruby
-def what?
-  42
-end
-~~~
-{kdexample}
-
-
-## Horizontal Rules
-
-{kdlink: {oid: horizontal-rules, part: "horizontal rules"}}
-
-It is easy to insert a horizontal rule in kramdown: just use three or more asterisks, dashes or
-underscores, optionally separated by spaces or tabs, on an otherwise blank line:
-
-{kdexample::}
-* * *
-
-\---
-
-  _  _  _  _
-
----------------
-{kdexample}
-
-
-## Lists
-
-{kdlink: {oid: lists, part: "lists"}}
-
-kramdown supports ordered and unordered lists. Ordered lists are started by using a number followed
-by a period, a space and then the list item text. The content of a list item consists of block-level
-elements. All lines which have the same indent as the text of the line with the list marker belong
-to the list item:
-
-{kdexample::}
-1. This is a list item
-2. And another item
-2. And the third one
-   with additional text
-{kdexample}
-
-As with block quotes, you may be lazy when using the list item marker:
-
-{kdexample::}
-* A list item
-with additional text
-{kdexample}
-
-As the content consists of block-level elements you can do things like the following:
-
-{kdexample::}
-1.  This is a list item
-
-    > with a blockquote
-
-    # And a header
-
-2.  Followed by another item
-{kdexample}
-
-Nested lists are also easy to create:
-
-{kdexample::}
-1. Item one
-   1. sub item one
-   2. sub item two
-   3. sub item three
-2. Item two
-{kdexample}
-
-Lists can occur directly after other block-level elements, however, there has to be at least one
-blank line if you want to follow a paragraph with a list:
-
-{kdexample::}
-This is a paragraph.
-1. This is NOT a list.
-
-1. This is a list!
-{kdexample}
-
-Unordered lists are started by using an asterisk, a dash or a plus sign (they can be mixed) and a
-space. Apart from that unordered lists follow the same rules as ordered lists:
-
-{kdexample::}
-* Item one
-+ Item two
-- Item three
-{kdexample}
-
-## Definition Lists
-
-{kdlink: {oid: definition-lists, part: "definition lists"}}
-
-A definition list works similar to a normal list and is used to associate definitions with terms.
-Definition lists are started when a normal paragraph is followed by a line starting with a colon and
-then the definition text. One term can have many definitions and multiple terms can have the same
-definition. Each line of the preceding paragraph is assumed to contain one term, for example:
-
-{kdexample::}
-term
-: definition
-: another definition
-
-another term
-and another term
-: and a definition for the term
-{kdexample}
-
-If you insert a blank line before a definition (note: there must only be one blank line between the
-terms and the first definition), the definition will be wrapped in a paragraph:
-
-{kdexample::}
-term
-
-: definition
-: definition
-{kdexample}
-
-Each term can be styled using span-level elements and each definition is parsed as block-level
-elements, i.e. you can use any block-level in a definition. Just use the same indent for the lines
-following the definition line:
-
-{kdexample::}
-This *is* a term
-
-: This will be a para
-
-  > a blockquote
-
-  # A header
-{kdexample}
-
-
-## Tables
-
-{kdlink: {oid: tables, part: "tables"}}
-
-kramdown supports a syntax for creating simple tables. A line starting with a pipe character (`|`)
-starts a table row. However, if the pipe characters is immediately followed by a dash (`-`), a
-separator line is created. Separator lines are used to split the table header from the table body
-(and optionally align the table columns) and to split the table body into multiple parts. If the
-pipe character is followed by an equal sign (`=`), the tables rows below it are part of the table
-footer.
-
-{kdexample::}
-| A simple | table |
-| with multiple | lines|
-{kdexample}
-
-{kdexample::}
-| Header1 | Header2 | Header3 |
-|:--------|:-------:|--------:|
-| cell1   | cell2   | cell3   |
-| cell4   | cell5   | cell6   |
-|----
-| cell1   | cell2   | cell3   |
-| cell4   | cell5   | cell6   |
-|=====
-| Foot1   | Foot2   | Foot3
-{: rules="groups"}
-{kdexample}
-
-
-## HTML elements
-
-{kdlink: {oid: html-blocks, part: "HTML blocks"}}
-
-kramdown allows you to use block-level HTML tags (`div`, `p`, `pre`, ...) to markup whole blocks of
-text -- just start a line with a block-level HTML tag. kramdown syntax is normally not processed
-inside an HTML tag but this can be changed with the `parse_block_html` option. If this options is
-set to `true`, then the content of a block-level HTML tag is parsed by kramdown either as block
-level or span-level text, depending on the tag:
-
-{kdexample::}
-<div style="float: right">
-Something that stays right and is not wrapped in a para.
-</div>
-
-{::options parse_block_html="true" /}
-
-<div>
-This is wrapped in a para.
-</div>
-<p>
-This can contain only *span* level elements.
-</p>
-{kdexample}
-
-
-## Block Attributes
-
-{kdlink: {oid: block-ials, part: "block IALs"}}
-{kdlink: {oid: attribute-list-definitions, part: "ALDs"}}
-
-You can assign any attribute to a block-level element. Just directly follow the block with a *block
-inline attribute list* (or short: block IAL). A block IAL consists of a left curly brace, followed
-by a colon, the attribute definitions and a right curly brace. Here is a simple example which sets the
-`title` attribute of a block quote:
-
-{kdexample::}
-> A nice blockquote
-{: title="Blockquote title"}
-{kdexample}
-
-As one often wants to set one or more CSS classes on an element, there is an easy shortcut:
-
-{kdexample::}
-> A nice blockquote
-{: .class1 .class2}
-{kdexample}
-
-A shortcut for setting the ID is also provided. Just prefix the ID with a hash symbol:
-
-{kdexample::}
-> A nice blockquote
-{: #with-an-id}
-{kdexample}
-
-Sometimes one wants to use the same attributes for many elements. kramdown allows you to define the
-attributes in one place with an *attribute list definition* (or short: ALD) and just reference this
-definition in a block IAL. An ALD has the same structure as a block IAL but the colon has to be
-replace with a colon, the reference name and another colon. By just using the reference name as-is
-in a block IAL, one can include the attributes of the referenced ALD:
-
-{kdexample::}
-{:refdef: .c1 #id .c2 title="title"}
-paragraph
-{: refdef}
-{kdexample}
-
-The order in a block IAL or ALD is important because later defined attributes overwrite (with the
-exception of the shortcut for CSS classes) prior defined attributes:
-
-{kdexample::}
-{:refdef: .c1 #id .c2 title="title"}
-paragraph
-{: refdef .c3 title="t" #para}
-{kdexample}
-
-
-## Extensions
-
-{kdlink: {oid: extensions, part: "extensions"}}
-
-kramdown provides some less used functionality through a common syntax. This will allow the easy
-addition of other extensions if need arises. Currently, there are extensions for ignoring text (i.e.
-treating text as comment), for inserting arbitrary text as-is into the output and for setting
-kramdown options.
-
-Here is an example that shows how to insert comments into text:
-
-{kdexample::}
-This is a paragraph
-{::comment}
-This is a comment which is
-completely ignored.
-{:/comment}
-... paragraph continues here.
-
-Extensions can also be used
-inline {::nomarkdown}**see**{:/}!
-{kdexample}
-
-As one can see from the above example, the syntax for extensions is nearly identical to that of
-ALDs. However, there is no trailing colon after the extension name and the extension end tag needs a
-slash between the colon and the extension name. One can also use the short form of the end tag, i.e.
-`{:/}`. Attribute definitions can be specified on the start tag by separating them with a space from
-the extension name. Also, if the extension does not have a body, there needs to be a slash right
-before the closing brace:
-
-{kdexample::}
-{::options auto_ids="false" /}
-
-# Header without id
-{kdexample}
-
-
-
-
-# Span-Level Elements - Text Modifiers
-
-## Emphasis
-
-{kdlink: {oid: emphasis, part: "emphasis"}}
-
-Emphasis can be added to text by surrounding the text with either asterisks or underscores:
-
-{kdexample::}
-This is *emphasized*,
-_this_ too!
-{kdexample}
-
-Strong emphasis can be done by doubling the delimiters:
-
-{kdexample::}
-This is **strong**,
-__this__ too!
-{kdexample}
-
-The form with the asterisks can also be used to markup parts of words:
-
-{kdexample::}
-This w**ork**s as expected!
-{kdexample}
-
-
-## Links and Images
-
-{kdlink: {oid: links-and-images, part: "links and images"}}
-
-A simple link can be created by surrounding the text with square brackets and the link URL with
-parentheses:
-
-{kdexample::}
-A [link](http://kramdown.gettalong.org)
-to the kramdown homepage.
-{kdexample}
-
-You can also add title information to the link:
-
-{kdexample::}
-A [link](http://kramdown.gettalong.org "hp")
-to the homepage.
-{kdexample}
-
-There is another way to create links which does not interrupt the text flow. The URL and title are
-defined using a reference name and this reference name is then used in square brackets instead of
-the link URL:
-
-{kdexample::}
-A [link][kramdown hp]
-to the homepage.
-
-[kramdown hp]: http://kramdown.gettalong.org "hp"
-{kdexample}
-
-If the link text itself is the reference name, the second set of square brackets can be omitted:
-
-{kdexample::}
-A link to the [kramdown hp].
-
-[kramdown hp]: http://kramdown.gettalong.org "hp"
-{kdexample}
-
-Images can be created in a similar way: just use an exclamation mark before the square brackets. The
-link text will become the alternative text of the image and the link URL specifies the image source:
-
-{kdexample::}
-An image: ![gras](img/image.jpg)
-{kdexample}
-
-
-## Inline Code
-
-{kdlink: {oid: code-spans, part: "code spans"}}
-
-Text phrases can be easily marked up as code by surrounding them with backticks:
-
-{kdexample::}
-Use `Kramdown::Document.new(text).to_html`
-to convert the `text` in kramdown
-syntax to HTML.
-{kdexample}
-
-If you want to use literal backticks in your code, just use two or more backticks as delimiters. The
-space right after the beginning delimiter and the one right before the closing delimiter are ignored:
-
-{kdexample::}
-Use backticks to markup code,
-e.g. `` `code` ``.
-{kdexample}
-
-
-## Footnotes
-
-{kdlink: {oid: footnotes, part: "footnotes"}}
-
-Footnotes can easily be used in kramdown. Just set a footnote marker (consists of square brackets
-with a caret and the footnote name inside) in the text and somewhere else the footnote definition (which
-basically looks like a reference link definition):
-
-{kdexample::}
-This is a text with a
-footnote[^1].
-
-[^1]: And here is the definition.
-{kdexample}
-
-The footnote definition can contain any block-level element, all lines following a footnote
-definition indented with four spaces or one tab belong to the definition:
-
-{kdexample::}
-This is a text with a
-footnote[^2].
-
-[^2]:
-    And here is the definition.
-
-    > With a quote!
-{kdexample}
-
-As can be seen above the footnote name is only used for the anchors and the numbering is done
-automatically in document order.  Repeated footnote markers will link to the same footnote
-definition.
-
-
-## Abbreviations
-
-{kdlink: {oid: abbreviations, part: "abbreviations"}}
-
-Abbreviations will work out of the box once you add an abbreviation definition. So you can just
-write the text and add the definitions later on.
-
-{kdexample::}
-This is an HTML
-example.
-
-*[HTML]: Hyper Text Markup Language
-{kdexample}
-
-
-## HTML Elements
-
-{kdlink: {oid: html-spans, part: "HTML spans"}}
-
-HTML is not only supported on the block-level but also on the span-level:
-
-{kdexample::}
-This is <span style="color: red">written in
-red</span>.
-{kdexample}
-
-
-## Inline Attributes
-
-{kdlink: {oid: span-ials, part: "span IALs"}}
-
-As with a block-level element you can assign any attribute to a span-level elements using a *span
-inline attribute list* (or short: span IAL). A span IAL has the same syntax as a block IAL and must
-immediately follow the span-level element:
-
-{kdexample::}
-This is *red*{: style="color: red"}.
-{kdexample}