kramdown 1.17.0 → 2.0.0.beta1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of kramdown might be problematic. Click here for more details.
- checksums.yaml +4 -4
- data/CONTRIBUTERS +4 -2
- data/VERSION +1 -1
- data/bin/kramdown +13 -14
- data/lib/kramdown.rb +2 -2
- data/lib/kramdown/converter.rb +6 -7
- data/lib/kramdown/converter/base.rb +18 -29
- data/lib/kramdown/converter/hash_ast.rb +4 -4
- data/lib/kramdown/converter/html.rb +82 -67
- data/lib/kramdown/converter/kramdown.rb +83 -78
- data/lib/kramdown/converter/latex.rb +53 -47
- data/lib/kramdown/converter/man.rb +22 -25
- data/lib/kramdown/converter/math_engine/mathjax.rb +10 -10
- data/lib/kramdown/converter/remove_html_tags.rb +2 -2
- data/lib/kramdown/converter/syntax_highlighter.rb +2 -2
- data/lib/kramdown/converter/syntax_highlighter/minted.rb +2 -2
- data/lib/kramdown/converter/syntax_highlighter/rouge.rb +5 -5
- data/lib/kramdown/converter/toc.rb +5 -5
- data/lib/kramdown/document.rb +9 -11
- data/lib/kramdown/element.rb +11 -9
- data/lib/kramdown/error.rb +2 -2
- data/lib/kramdown/options.rb +258 -384
- data/lib/kramdown/parser.rb +2 -3
- data/lib/kramdown/parser/base.rb +7 -6
- data/lib/kramdown/parser/html.rb +103 -95
- data/lib/kramdown/parser/kramdown.rb +32 -36
- data/lib/kramdown/parser/kramdown/abbreviation.rb +13 -10
- data/lib/kramdown/parser/kramdown/autolink.rb +3 -3
- data/lib/kramdown/parser/kramdown/blank_line.rb +2 -2
- data/lib/kramdown/parser/kramdown/block_boundary.rb +2 -2
- data/lib/kramdown/parser/kramdown/blockquote.rb +4 -5
- data/lib/kramdown/parser/kramdown/codeblock.rb +4 -5
- data/lib/kramdown/parser/kramdown/codespan.rb +5 -5
- data/lib/kramdown/parser/kramdown/emphasis.rb +6 -6
- data/lib/kramdown/parser/kramdown/eob.rb +2 -2
- data/lib/kramdown/parser/kramdown/escaped_chars.rb +2 -2
- data/lib/kramdown/parser/kramdown/extensions.rb +31 -26
- data/lib/kramdown/parser/kramdown/footnote.rb +7 -6
- data/lib/kramdown/parser/kramdown/header.rb +6 -6
- data/lib/kramdown/parser/kramdown/horizontal_rule.rb +3 -3
- data/lib/kramdown/parser/kramdown/html.rb +31 -26
- data/lib/kramdown/parser/kramdown/html_entity.rb +6 -5
- data/lib/kramdown/parser/kramdown/line_break.rb +3 -3
- data/lib/kramdown/parser/kramdown/link.rb +13 -11
- data/lib/kramdown/parser/kramdown/list.rb +38 -40
- data/lib/kramdown/parser/kramdown/math.rb +4 -5
- data/lib/kramdown/parser/kramdown/paragraph.rb +5 -5
- data/lib/kramdown/parser/kramdown/smart_quotes.rb +23 -23
- data/lib/kramdown/parser/kramdown/table.rb +18 -17
- data/lib/kramdown/parser/kramdown/typographic_symbol.rb +8 -8
- data/lib/kramdown/parser/markdown.rb +9 -8
- data/lib/kramdown/utils.rb +5 -6
- data/lib/kramdown/utils/configurable.rb +7 -6
- data/lib/kramdown/utils/entities.rb +286 -289
- data/lib/kramdown/utils/html.rb +10 -12
- data/lib/kramdown/utils/lru_cache.rb +3 -2
- data/lib/kramdown/utils/string_scanner.rb +2 -3
- data/lib/kramdown/utils/unidecoder.rb +8 -6
- data/lib/kramdown/version.rb +3 -3
- data/man/man1/kramdown.1 +3 -107
- data/test/run_tests.rb +6 -6
- data/test/test_files.rb +122 -298
- data/test/test_location.rb +8 -30
- data/test/test_string_scanner_kramdown.rb +6 -9
- data/test/testcases/block/06_codeblock/highlighting-opts.html +6 -6
- data/test/testcases/block/06_codeblock/highlighting.html +5 -6
- data/test/testcases/block/06_codeblock/with_lang_in_fenced_block.options +1 -1
- data/test/testcases/block/07_horizontal_rule/error.html +2 -2
- data/test/testcases/block/09_html/html5_attributes.html +2 -0
- data/test/testcases/block/09_html/html5_attributes.text +2 -0
- data/test/testcases/block/09_html/html_to_native/typography.html +1 -1
- data/test/testcases/block/09_html/simple.html +1 -1
- data/test/testcases/block/12_extension/options3.html +7 -6
- data/test/testcases/block/12_extension/options3.text +2 -2
- data/test/testcases/span/01_link/inline.html +1 -1
- data/test/testcases/span/01_link/reference.html +3 -3
- data/test/testcases/span/03_codespan/highlighting.html +1 -1
- data/test/testcases/span/text_substitutions/entities_as_char.html +1 -1
- metadata +5 -234
- data/Rakefile +0 -341
- data/benchmark/benchmark.rb +0 -43
- data/benchmark/benchmark.sh +0 -74
- data/benchmark/generate_data.rb +0 -119
- data/benchmark/mdbasics.text +0 -306
- data/benchmark/mdsyntax.text +0 -888
- data/benchmark/testing.sh +0 -12
- data/benchmark/timing.sh +0 -10
- data/doc/_design.scss +0 -441
- data/doc/bg.png +0 -0
- data/doc/default.scss +0 -217
- data/doc/default.template +0 -62
- data/doc/documentation.page +0 -84
- data/doc/documentation.template +0 -36
- data/doc/index.page +0 -113
- data/doc/installation.page +0 -88
- data/doc/links.markdown +0 -6
- data/doc/metainfo +0 -13
- data/doc/news.feed +0 -9
- data/doc/news.page +0 -29
- data/doc/options.page +0 -49
- data/doc/quickref.page +0 -603
- data/doc/sidebar.template +0 -22
- data/doc/sitemap.sitemap +0 -5
- data/doc/syntax.page +0 -1799
- data/doc/tests.page +0 -104
- data/doc/virtual +0 -14
- data/lib/kramdown/converter/math_engine/itex2mml.rb +0 -39
- data/lib/kramdown/converter/math_engine/katex.rb +0 -35
- data/lib/kramdown/converter/math_engine/mathjaxnode.rb +0 -56
- data/lib/kramdown/converter/math_engine/ritex.rb +0 -38
- data/lib/kramdown/converter/math_engine/sskatex.rb +0 -97
- data/lib/kramdown/converter/pdf.rb +0 -625
- data/lib/kramdown/converter/syntax_highlighter/coderay.rb +0 -81
- data/lib/kramdown/parser/gfm.rb +0 -188
- data/lib/kramdown/utils/ordered_hash.rb +0 -18
- data/setup.rb +0 -1585
- data/test/testcases/block/07_horizontal_rule/error.html.19 +0 -7
- data/test/testcases/block/09_html/html_to_native/typography.html.19 +0 -1
- data/test/testcases/block/09_html/simple.html.19 +0 -60
- data/test/testcases/block/15_math/itex2mml.html +0 -1
- data/test/testcases/block/15_math/itex2mml.options +0 -1
- data/test/testcases/block/15_math/itex2mml.text +0 -1
- data/test/testcases/block/15_math/katex.html.19 +0 -2
- data/test/testcases/block/15_math/katex.options +0 -1
- data/test/testcases/block/15_math/katex.text +0 -2
- data/test/testcases/block/15_math/mathjaxnode.html.19 +0 -27
- data/test/testcases/block/15_math/mathjaxnode.options +0 -1
- data/test/testcases/block/15_math/mathjaxnode.text +0 -1
- data/test/testcases/block/15_math/mathjaxnode_notexhints.html.19 +0 -23
- data/test/testcases/block/15_math/mathjaxnode_notexhints.options +0 -3
- data/test/testcases/block/15_math/mathjaxnode_notexhints.text +0 -1
- data/test/testcases/block/15_math/mathjaxnode_semantics.html.19 +0 -32
- data/test/testcases/block/15_math/mathjaxnode_semantics.options +0 -3
- data/test/testcases/block/15_math/mathjaxnode_semantics.text +0 -1
- data/test/testcases/block/15_math/ritex.html +0 -1
- data/test/testcases/block/15_math/ritex.options +0 -1
- data/test/testcases/block/15_math/ritex.text +0 -1
- data/test/testcases/block/15_math/sskatex.html.19 +0 -2
- data/test/testcases/block/15_math/sskatex.options +0 -1
- data/test/testcases/block/15_math/sskatex.text +0 -2
- data/test/testcases/span/01_link/inline.html.19 +0 -46
- data/test/testcases/span/01_link/reference.html.19 +0 -37
- data/test/testcases/span/math/itex2mml.html +0 -1
- data/test/testcases/span/math/itex2mml.options +0 -1
- data/test/testcases/span/math/itex2mml.text +0 -1
- data/test/testcases/span/math/katex.html.19 +0 -1
- data/test/testcases/span/math/katex.options +0 -1
- data/test/testcases/span/math/katex.text +0 -1
- data/test/testcases/span/math/mathjaxnode.html.19 +0 -27
- data/test/testcases/span/math/mathjaxnode.options +0 -1
- data/test/testcases/span/math/mathjaxnode.text +0 -1
- data/test/testcases/span/math/ritex.html +0 -1
- data/test/testcases/span/math/ritex.options +0 -1
- data/test/testcases/span/math/ritex.text +0 -1
- data/test/testcases/span/math/sskatex.html.19 +0 -1
- data/test/testcases/span/math/sskatex.options +0 -1
- data/test/testcases/span/math/sskatex.text +0 -1
- data/test/testcases/span/text_substitutions/entities_as_char.html.19 +0 -1
- data/test/testcases_gfm/atx_header.html +0 -3
- data/test/testcases_gfm/atx_header.text +0 -3
- data/test/testcases_gfm/backticks_disable_highlighting.html +0 -2
- data/test/testcases_gfm/backticks_disable_highlighting.options +0 -1
- data/test/testcases_gfm/backticks_disable_highlighting.text +0 -3
- data/test/testcases_gfm/backticks_syntax.html +0 -20
- data/test/testcases_gfm/backticks_syntax.text +0 -19
- data/test/testcases_gfm/codeblock_fenced.html +0 -20
- data/test/testcases_gfm/codeblock_fenced.options +0 -1
- data/test/testcases_gfm/codeblock_fenced.text +0 -21
- data/test/testcases_gfm/hard_line_breaks.html +0 -3
- data/test/testcases_gfm/hard_line_breaks.text +0 -3
- data/test/testcases_gfm/hard_line_breaks_off.html +0 -2
- data/test/testcases_gfm/hard_line_breaks_off.options +0 -1
- data/test/testcases_gfm/hard_line_breaks_off.text +0 -2
- data/test/testcases_gfm/header_ids.html +0 -27
- data/test/testcases_gfm/header_ids.html.19 +0 -27
- data/test/testcases_gfm/header_ids.options +0 -1
- data/test/testcases_gfm/header_ids.text +0 -27
- data/test/testcases_gfm/header_ids_with_prefix.html +0 -3
- data/test/testcases_gfm/header_ids_with_prefix.options +0 -2
- data/test/testcases_gfm/header_ids_with_prefix.text +0 -3
- data/test/testcases_gfm/no_typographic.html +0 -3
- data/test/testcases_gfm/no_typographic.html.19 +0 -3
- data/test/testcases_gfm/no_typographic.options +0 -1
- data/test/testcases_gfm/no_typographic.text +0 -3
- data/test/testcases_gfm/paragraph_end-disabled.html +0 -31
- data/test/testcases_gfm/paragraph_end-disabled.options +0 -1
- data/test/testcases_gfm/paragraph_end-disabled.text +0 -27
- data/test/testcases_gfm/paragraph_end.html +0 -38
- data/test/testcases_gfm/paragraph_end.text +0 -27
- data/test/testcases_gfm/strikethrough.html +0 -27
- data/test/testcases_gfm/strikethrough.html.19 +0 -27
- data/test/testcases_gfm/strikethrough.text +0 -27
- data/test/testcases_gfm/task_list.html +0 -40
- data/test/testcases_gfm/task_list.text +0 -26
- data/test/testcases_gfm/two_para_hard_line_breaks.html +0 -4
- data/test/testcases_gfm/two_para_hard_line_breaks.text +0 -4
data/doc/bg.png
DELETED
Binary file
|
data/doc/default.scss
DELETED
@@ -1,217 +0,0 @@
|
|
1
|
-
@import 'design';
|
2
|
-
|
3
|
-
a:hover {
|
4
|
-
background-color: rgba(0,0,0,0.1);
|
5
|
-
}
|
6
|
-
|
7
|
-
aside.banner {
|
8
|
-
font-size: 18px;
|
9
|
-
line-height: 27px;
|
10
|
-
}
|
11
|
-
|
12
|
-
aside a {
|
13
|
-
text-decoration: none;
|
14
|
-
|
15
|
-
&:hover, &:link {
|
16
|
-
text-decoration: underline;
|
17
|
-
}
|
18
|
-
|
19
|
-
}
|
20
|
-
|
21
|
-
#content {
|
22
|
-
blockquote.information {
|
23
|
-
border-left: 12px solid #080;
|
24
|
-
background-color: #bfb;
|
25
|
-
padding: 12px 12px 12px 0;
|
26
|
-
margin-left: -48px;
|
27
|
-
padding-left: 48px;
|
28
|
-
}
|
29
|
-
|
30
|
-
blockquote.markdown-difference {
|
31
|
-
border-left: 12px solid #dc0;
|
32
|
-
background-color: #ffa;
|
33
|
-
padding: 12px 12px 12px 0;
|
34
|
-
margin-left: -48px;
|
35
|
-
padding-left: 48px;
|
36
|
-
|
37
|
-
&:before {
|
38
|
-
content: "Difference to Standard Markdown";
|
39
|
-
display: block;
|
40
|
-
font-weight: bold;
|
41
|
-
}
|
42
|
-
}
|
43
|
-
|
44
|
-
blockquote pre {
|
45
|
-
border: none;
|
46
|
-
}
|
47
|
-
|
48
|
-
table {
|
49
|
-
border-collapse: collapse;
|
50
|
-
margin-left: auto;
|
51
|
-
margin-right: auto;
|
52
|
-
width: 100%;
|
53
|
-
|
54
|
-
td, th {
|
55
|
-
padding: 3px 5px;
|
56
|
-
}
|
57
|
-
th {
|
58
|
-
background-color: #080;
|
59
|
-
color: white;
|
60
|
-
}
|
61
|
-
}
|
62
|
-
|
63
|
-
pre.show-whitespaces .ws-space {
|
64
|
-
background-color: #f44;
|
65
|
-
}
|
66
|
-
pre.show-whitespaces .ws-space-l {
|
67
|
-
background-color: #f22;
|
68
|
-
}
|
69
|
-
pre.show-whitespaces .ws-space-r {
|
70
|
-
background-color: #f00;
|
71
|
-
}
|
72
|
-
pre.show-whitespaces .ws-tab {
|
73
|
-
background-color: #ff4;
|
74
|
-
}
|
75
|
-
pre.show-whitespaces .ws-tab-l {
|
76
|
-
background-color: #ff2;
|
77
|
-
}
|
78
|
-
pre.show-whitespaces .ws-tab-r {
|
79
|
-
background-color: #ff0;
|
80
|
-
}
|
81
|
-
pre.show-whitespaces.ws-lr .ws-tab {
|
82
|
-
background-color: inherit;
|
83
|
-
}
|
84
|
-
pre.show-whitespaces.ws-lr .ws-space {
|
85
|
-
background-color: inherit;
|
86
|
-
opacity: 0;
|
87
|
-
}
|
88
|
-
|
89
|
-
table.kdexample td {
|
90
|
-
vertical-align: top;
|
91
|
-
}
|
92
|
-
|
93
|
-
table.kdexample pre {
|
94
|
-
margin: 5px 0px;
|
95
|
-
}
|
96
|
-
|
97
|
-
.kdexample:hover .kdexample-after-source {
|
98
|
-
display: block;
|
99
|
-
}
|
100
|
-
|
101
|
-
.kdexample-after-source {
|
102
|
-
display: none;
|
103
|
-
background-color: #ffffee;
|
104
|
-
border: 2px solid #e6e8e9;
|
105
|
-
margin: 0 10px;
|
106
|
-
padding: 5px;
|
107
|
-
}
|
108
|
-
|
109
|
-
.kdexample-after-live {
|
110
|
-
background-color: #eeffee;
|
111
|
-
border: 2px solid #e6e8e9;
|
112
|
-
margin: 5px 0px 12px;
|
113
|
-
padding: 5px;
|
114
|
-
}
|
115
|
-
|
116
|
-
div.kdsyntaxlink {
|
117
|
-
float: right;
|
118
|
-
position: relative;
|
119
|
-
top: -17px;
|
120
|
-
padding: 5px;
|
121
|
-
border: 1px solid #e6e8e9;
|
122
|
-
margin-right: 10px;
|
123
|
-
margin-left: 10px;
|
124
|
-
|
125
|
-
a {
|
126
|
-
text-decoration: none;
|
127
|
-
}
|
128
|
-
}
|
129
|
-
}
|
130
|
-
|
131
|
-
.news-item {
|
132
|
-
border-top: 2px solid #ddd;
|
133
|
-
margin-top: 46px;
|
134
|
-
}
|
135
|
-
|
136
|
-
.news-date {
|
137
|
-
float: right;
|
138
|
-
margin-top: 2px;
|
139
|
-
font-size: small;
|
140
|
-
color: #888;
|
141
|
-
}
|
142
|
-
|
143
|
-
footer {
|
144
|
-
clear: both;
|
145
|
-
font-size: 92%;
|
146
|
-
text-align: left;
|
147
|
-
|
148
|
-
a {
|
149
|
-
color: #898989;
|
150
|
-
|
151
|
-
&:hover {
|
152
|
-
text-decoration: none;
|
153
|
-
color: #666;
|
154
|
-
}
|
155
|
-
}
|
156
|
-
}
|
157
|
-
|
158
|
-
/* common rules */
|
159
|
-
acronym {
|
160
|
-
cursor: help;
|
161
|
-
border-bottom: 1px solid #777;
|
162
|
-
}
|
163
|
-
|
164
|
-
.float-left {
|
165
|
-
float: left;
|
166
|
-
}
|
167
|
-
|
168
|
-
.float-right {
|
169
|
-
float: right;
|
170
|
-
}
|
171
|
-
|
172
|
-
.a-left, tr.a-left td {
|
173
|
-
text-align: left;
|
174
|
-
}
|
175
|
-
|
176
|
-
.a-center, tr.a-center td {
|
177
|
-
text-align: center;
|
178
|
-
}
|
179
|
-
|
180
|
-
.a-right, tr.a-right td {
|
181
|
-
text-align: right;
|
182
|
-
}
|
183
|
-
|
184
|
-
.clear {
|
185
|
-
clear: both;
|
186
|
-
}
|
187
|
-
|
188
|
-
.inline-important {
|
189
|
-
font-weight: bold;
|
190
|
-
display: block;
|
191
|
-
text-align: center;
|
192
|
-
}
|
193
|
-
|
194
|
-
|
195
|
-
.patreon, .patreon:hover {
|
196
|
-
border-radius: 50px;
|
197
|
-
padding: 5px 10px;
|
198
|
-
margin: 0 5px;
|
199
|
-
display: inline-block;
|
200
|
-
text-decoration: none !important;
|
201
|
-
background-color: #e6461a !important;
|
202
|
-
box-shadow: 0px 0px 5px 5px #e6461a;
|
203
|
-
color: white !important;
|
204
|
-
font-weight: bold;
|
205
|
-
|
206
|
-
&:hover {
|
207
|
-
box-shadow: 0px 0px 0px 5px #e6461a;
|
208
|
-
}
|
209
|
-
}
|
210
|
-
|
211
|
-
#call-to-arms {
|
212
|
-
text-align: center;
|
213
|
-
margin: 40px 0 10px;
|
214
|
-
background-color: rgba(255, 255, 255, 0.18);
|
215
|
-
padding: 30px;
|
216
|
-
border-radius: 100px;
|
217
|
-
}
|
data/doc/default.template
DELETED
@@ -1,62 +0,0 @@
|
|
1
|
-
<!doctype html>
|
2
|
-
<html xml:lang="{lang:}" lang="{lang:}">
|
3
|
-
<head>
|
4
|
-
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
5
|
-
<meta name="author" content="Thomas Leitner" />
|
6
|
-
<meta name="copyright" content="2009-2016 Thomas Leitner" />
|
7
|
-
<meta name="description" content="kramdown is a fast, pure-Ruby Markdown-superset converter" />
|
8
|
-
<meta name="keywords" content="ruby, kramdown, markdown, text markup" />
|
9
|
-
<link href="{relocatable: default.css}" type="text/css" rel="stylesheet" media="screen,projection" />
|
10
|
-
<link href="{relocatable: news.atom}" type="application/atom+xml" rel="alternate" />
|
11
|
-
<title>{title:} | kramdown</title>
|
12
|
-
</head>
|
13
|
-
<body>
|
14
|
-
<header>
|
15
|
-
<hgroup>
|
16
|
-
<h1 id="logo"><a href="{relocatable: /}" title="Homepage">kramdown</a></h1>
|
17
|
-
<h2 id="slogan">fast, pure-Ruby Markdown-superset converter</h2>
|
18
|
-
</hgroup>
|
19
|
-
|
20
|
-
<nav>
|
21
|
-
{menu: {options: {mi: {in_menu: true}, sort: sort_info, flatten: true}}}
|
22
|
-
</nav>
|
23
|
-
</header>
|
24
|
-
|
25
|
-
<div id="wrapper">
|
26
|
-
<% if context.content_node.blocks.has_key?('intro') %>
|
27
|
-
<aside class="banner">
|
28
|
-
<webgen:block name="intro" node="first" />
|
29
|
-
</aside>
|
30
|
-
<% end %>
|
31
|
-
|
32
|
-
<aside>
|
33
|
-
<webgen:block name="sidebar" node="first" notfound="ignore" />
|
34
|
-
|
35
|
-
<webgen:block name="content" chain="sidebar.template" />
|
36
|
-
</aside>
|
37
|
-
|
38
|
-
<div id="content">
|
39
|
-
<webgen:block name="content" node="first" />
|
40
|
-
</div>
|
41
|
-
<div style="clear:both"></div>
|
42
|
-
</div>
|
43
|
-
|
44
|
-
<footer>
|
45
|
-
<div class="float-left">Copyright © 2009-2016 Thomas Leitner</div>
|
46
|
-
<div class="float-right">Generated by <a href="https://webgen.gettalong.org">webgen</a></div>
|
47
|
-
</footer>
|
48
|
-
|
49
|
-
<script src="//static.gettalong.org/MathJax/MathJax.js?config=default.js" type="text/javascript"></script>
|
50
|
-
<!-- Start of StatCounter Code for Default Guide -->
|
51
|
-
<script type="text/javascript">
|
52
|
-
var sc_project=4267845;
|
53
|
-
var sc_invisible=1;
|
54
|
-
var sc_security="41321455";
|
55
|
-
var sc_client_storage="disabled";
|
56
|
-
</script>
|
57
|
-
<script type="text/javascript" src="https://www.statcounter.com/counter/counter.js" async="async"></script>
|
58
|
-
<noscript><div class="statcounter"><a title="website statistics" href="http://statcounter.com/" target="_blank"><img class="statcounter" src="//c.statcounter.com/4267845/0/41321455/1/" alt="website statistics" /></a></div></noscript>
|
59
|
-
<!-- End of StatCounter Code for Default Guide -->
|
60
|
-
|
61
|
-
</body>
|
62
|
-
</html>
|
data/doc/documentation.page
DELETED
@@ -1,84 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: Documentation
|
3
|
-
in_menu: true
|
4
|
-
sort_info: 7
|
5
|
-
---
|
6
|
-
# kramdown Documentation
|
7
|
-
|
8
|
-
## Overview
|
9
|
-
|
10
|
-
kramdown is first and foremost a library for converting text written in a superset of Markdown to
|
11
|
-
HTML. However, due to its modular architecture it is able to support additional input and output
|
12
|
-
formats. The following input and output formats are currently supported:
|
13
|
-
|
14
|
-
* Input: [kramdown](parser/kramdown.html) (a superset of Markdown),
|
15
|
-
[Markdown](parser/markdown.html), [Github Flavored Markdown](parser/gfm.html), [HTML](parser/html.html)
|
16
|
-
|
17
|
-
* Output: [HTML](converter/html.html), [LaTeX](converter/latex.html),
|
18
|
-
[kramdown](converter/kramdown.html), [RemoveHtmlTags](converter/remove_html_tags.html) (a special
|
19
|
-
converter which removes HTML tags, normally used in conjunction with the LaTeX or kramdown
|
20
|
-
converters)
|
21
|
-
|
22
|
-
The [kramdown syntax page](syntax.html) describes in detail what is supported and how it differs
|
23
|
-
from standard Markdown.
|
24
|
-
|
25
|
-
For all available options have a look at the [options documentation](options.html) or have a look at
|
26
|
-
a parser/converter page to see which options they support!
|
27
|
-
|
28
|
-
|
29
|
-
## Usage
|
30
|
-
|
31
|
-
{:ruby: .language-ruby}
|
32
|
-
|
33
|
-
The kramdown package provides two ways for using it:
|
34
|
-
|
35
|
-
* **As a library**
|
36
|
-
|
37
|
-
kramdown uses basically the same API as [RedCloth], [BlueCloth] and [Maruku]:
|
38
|
-
|
39
|
-
require 'kramdown'
|
40
|
-
|
41
|
-
puts Kramdown::Document.new(text).to_html
|
42
|
-
{:ruby}
|
43
|
-
|
44
|
-
The second parameter to the `new` call is an options hash for (de)activating certain features. For
|
45
|
-
example, to disable automatic header ID generation, you can do the following:
|
46
|
-
|
47
|
-
puts Kramdown::Document.new(text, :auto_ids => false).to_html
|
48
|
-
{:ruby}
|
49
|
-
|
50
|
-
The default parser used is `kramdown`, however, you can select a different one with the `:input`
|
51
|
-
option:
|
52
|
-
|
53
|
-
puts Kramdown::Document.new(text, :input => 'html').to_latex
|
54
|
-
{:ruby}
|
55
|
-
|
56
|
-
You can also reuse the created document object to produce multiple outputs:
|
57
|
-
|
58
|
-
doc = Kramdown::Document.new(text, :input => 'html')
|
59
|
-
puts doc.to_html
|
60
|
-
puts doc.to_latex
|
61
|
-
{:ruby}
|
62
|
-
|
63
|
-
More information on how to use or extend kramdown can be found in the [API
|
64
|
-
documentation](rdoc/index.html)!
|
65
|
-
|
66
|
-
* **As an application**
|
67
|
-
|
68
|
-
Together with the library files a binary called `kramdown` is shipped which can be used to convert
|
69
|
-
text in any supported input format to any supported output format. It either reads from the files
|
70
|
-
specified as the command line arguments or from the standard input. For example:
|
71
|
-
|
72
|
-
kramdown path/to/kramdown/doc/syntax.page
|
73
|
-
|
74
|
-
The input and output formats as well as all available kramdown options are supported through
|
75
|
-
command line switches.
|
76
|
-
|
77
|
-
|
78
|
-
## Tests
|
79
|
-
|
80
|
-
kramdown uses various test suites to verify the correct working of the parsers and converters. For
|
81
|
-
more information, have a look at the [tests document](tests.html).
|
82
|
-
|
83
|
-
|
84
|
-
{include_file: doc/links.markdown}
|
data/doc/documentation.template
DELETED
@@ -1,36 +0,0 @@
|
|
1
|
-
--- name:sidebar pipeline:erb,tags,kramdown
|
2
|
-
<div style="text-align: right">
|
3
|
-
<a href="https://www.patreon.com/bePatron?u=4908963" class="patreon">Become a Patron!</a>
|
4
|
-
</div>
|
5
|
-
|
6
|
-
<h1>Documentation</h1>
|
7
|
-
|
8
|
-
* Parsers
|
9
|
-
* [kramdown](parser/kramdown.html)
|
10
|
-
* [GFM](parser/gfm.html)
|
11
|
-
* [Markdown](parser/markdown.html)
|
12
|
-
* [HTML](parser/html.html)
|
13
|
-
* Converters
|
14
|
-
* [HTML](converter/html.html)
|
15
|
-
* [LaTeX](converter/latex.html)
|
16
|
-
* [man](converter/man.html)
|
17
|
-
* [kramdown](converter/kramdown.html)
|
18
|
-
* [RemoveHtmlTags](converter/remove_html_tags.html)
|
19
|
-
* Syntax Highlighters
|
20
|
-
* [Rouge](syntax_highlighter/rouge.html)
|
21
|
-
* [Coderay](syntax_highlighter/coderay.html)
|
22
|
-
* Math Engines
|
23
|
-
* [MathJax](math_engine/mathjax.html)
|
24
|
-
* [KaTeX](math_engine/katex.html)
|
25
|
-
* [SsKaTeX](math_engine/sskatex.html)
|
26
|
-
* [Mathjax-Node](math_engine/mathjaxnode.html)
|
27
|
-
* [Ritex](math_engine/ritex.html)
|
28
|
-
* [itex2MML](math_engine/itex2mml.html)
|
29
|
-
* [Configuration Options](options.html)
|
30
|
-
* [Tests](tests.html)
|
31
|
-
|
32
|
-
<% if context.node.children.first && context.node.children.first.children.length > 1 %>
|
33
|
-
<h1>Contents</h1>
|
34
|
-
<% end %>
|
35
|
-
|
36
|
-
{menu: {options: {descendants: true, levels: [3,6]}}}
|
data/doc/index.page
DELETED
@@ -1,113 +0,0 @@
|
|
1
|
-
---
|
2
|
-
title: Home
|
3
|
-
in_menu: true
|
4
|
-
sort_info: 1
|
5
|
-
---
|
6
|
-
## Overview
|
7
|
-
|
8
|
-
If you want to get started with kramdown, have a look at the [installation page](installation.html)
|
9
|
-
to see how you can install it on your system. Then look through the
|
10
|
-
[documentation](documentation.html) for finding information about how to actually use kramdown and
|
11
|
-
its parsers/converters. The [quick reference](quickref.html) provides a overview of the syntax -- if
|
12
|
-
you need a more detailed description of the superset of Markdown which kramdown supports the [syntax
|
13
|
-
page](syntax.html) is the place to go!
|
14
|
-
|
15
|
-
{tikz::
|
16
|
-
path: overview.png
|
17
|
-
img_attr: {style: 'background:transparent'}
|
18
|
-
content_processor.tikz.libraries: [mindmap, trees, arrows]
|
19
|
-
content_processor.tikz.transparent: true
|
20
|
-
content_processor.tikz.resolution: 300 100
|
21
|
-
content_processor.tikz.opts: |
|
22
|
-
mindmap, concept color=black, text=white,
|
23
|
-
root concept/.append style={font=\Large},
|
24
|
-
level 1 concept/.append style={font=\Large, minimum size=2.6cm},
|
25
|
-
level 2 concept/.append style={font=\Large},
|
26
|
-
}
|
27
|
-
\node[concept, font=\Large] (lib) {kramdown's internal representation}
|
28
|
-
child[concept color=orange, grow=120, ->] {node[concept] (i-kramdown) {kramdown}}
|
29
|
-
child[concept color=orange, grow=160] {node[concept] (i-html) {HTML}}
|
30
|
-
child[concept color=orange, grow=200] {node[concept] (i-gfm) {GFM}}
|
31
|
-
child[concept color=orange, grow=240] {node[concept] (i-markdown) {Markdown}}
|
32
|
-
child[concept color=green!50!black, grow=60] {node[concept] (o-html) {HTML}}
|
33
|
-
child[concept color=green!50!black, grow=20] {node[concept] (o-kramdown) {kramdown}}
|
34
|
-
child[concept color=green!50!black, grow=-20] {
|
35
|
-
node[concept] (o-latex) {\LaTeX}
|
36
|
-
child[grow=0] {
|
37
|
-
node[concept] (o-latex-pdf) {PDF}
|
38
|
-
}
|
39
|
-
}
|
40
|
-
child[concept color=green!50!black, grow=-60] {node[concept] (o-pdf) {PDF}}
|
41
|
-
;
|
42
|
-
\draw [dash pattern=on 0pt off 2pt,line width=5pt,arrows=-angle 60,shorten >=15pt,shorten <=10pt,color=orange]
|
43
|
-
(i-kramdown) edge(lib)
|
44
|
-
(i-markdown) edge(lib)
|
45
|
-
(i-html) edge (lib)
|
46
|
-
(i-gfm) edge (lib);
|
47
|
-
\draw [dash pattern=on 0pt off 2pt,line width=5pt,arrows=-angle 60,shorten >=10pt,shorten <=15pt,color=green!50!black]
|
48
|
-
(lib) edge(o-html)
|
49
|
-
(lib) edge (o-kramdown)
|
50
|
-
(lib) edge (o-latex)
|
51
|
-
(lib) edge (o-pdf);
|
52
|
-
{tikz}
|
53
|
-
{: style="text-align: center"}
|
54
|
-
|
55
|
-
|
56
|
-
## Bugs, Forums, Mailing Lists
|
57
|
-
|
58
|
-
If you have found a bug, you should [report it here][bug_report]. Also, there is the [kramdown-users
|
59
|
-
google group][ml] available if you have any questions!
|
60
|
-
|
61
|
-
[bug_report]: http://github.com/gettalong/kramdown/issues
|
62
|
-
[ml]: https://groups.google.com/forum/#!forum/kramdown-users
|
63
|
-
|
64
|
-
|
65
|
-
## Thanks
|
66
|
-
|
67
|
-
kramdown would not be possible without the prior work of many other people. I want to thank everyone
|
68
|
-
involved with making Markdown such a nice markup language and especially the developers of other
|
69
|
-
Markdown implementations because kramdown borrowed many ideas from existing packages.
|
70
|
-
|
71
|
-
|
72
|
-
## Author
|
73
|
-
|
74
|
-
* Thomas Leitner
|
75
|
-
* e-Mail: <mailto:t_leitner@gmx.at>
|
76
|
-
|
77
|
-
[PHP Markdown Extra]: http://michelf.com/projects/php-markdown/extra/
|
78
|
-
[Maruku]: http://maruku.rubyforge.org
|
79
|
-
[BlueFeather]: http://ruby.morphball.net/bluefeather/index_en.html
|
80
|
-
|
81
|
-
--- intro
|
82
|
-
<div markdown="1" itemscope="" itemtype="http://schema.org/SoftwareApplication">
|
83
|
-
<meta itemprop="applicationCategory" content="Markdown library, Markdown converter" />
|
84
|
-
<meta itemprop="operatingSystem" content="Linux, Windows, Mac OS X" />
|
85
|
-
<div itemprop="author" itemscope="" itemtype="http://schema.org/Person">
|
86
|
-
<meta itemprop="name" content="Thomas Leitner" />
|
87
|
-
<meta itemprop="email" content="t_leitner@gmx.at" />
|
88
|
-
</div>
|
89
|
-
|
90
|
-
**kramdown**{:itemprop="name"} (sic, not Kramdown or KramDown, just kramdown) is a *free*
|
91
|
-
[MIT](https://github.com/gettalong/kramdown/blob/master/COPYING){:itemprop="license"}-licensed
|
92
|
-
[Ruby](http://www.ruby-lang.org) library for parsing and converting a superset of Markdown. It is
|
93
|
-
completely written in Ruby, supports standard Markdown (with some minor modifications) and various
|
94
|
-
extensions that have been made popular by the [PHP Markdown Extra] package and [Maruku].
|
95
|
-
{:itemprop="description"}
|
96
|
-
|
97
|
-
It is probably the fastest pure-Ruby Markdown converter available (September 2014), being about 3x
|
98
|
-
faster than [Maruku] and about 4.5x faster than [BlueFeather].
|
99
|
-
|
100
|
-
Version **1.17.0**{:itemprop="softwareVersion"} released on
|
101
|
-
**2018-05-31**{:itemprop="datePublished"}, [more news](news.html)
|
102
|
-
{: style="text-align: center; font-size: 80%"}
|
103
|
-
|
104
|
-
</div>
|
105
|
-
|
106
|
-
<div id="call-to-arms">
|
107
|
-
Support kramdown development and <a href="https://www.patreon.com/bePatron?u=4908963" class="patreon">become a patron</a>!
|
108
|
-
</div>
|
109
|
-
|
110
|
-
|
111
|
-
[PHP Markdown Extra]: http://michelf.com/projects/php-markdown/extra/
|
112
|
-
[Maruku]: http://maruku.rubyforge.org
|
113
|
-
[BlueFeather]: http://ruby.morphball.net/bluefeather/index_en.html
|