Changesets can be listed by changeset number.
The Git repository is here.
- Revision:
- 373
- Log:
Initial import of Radiant 0.9.1, which is now packaged as a gem. This is an
import of the tagged 0.9.1 source checked out from GitHub, which isn't quite
the same as the gem distribution - but it doesn't seem to be available in an
archived form and the installed gem already has modifications, so this is
the closest I can get.
- Author:
- rool
- Date:
- Mon Mar 21 13:40:05 +0000 2011
- Size:
- 5495 Bytes
1 | .TH "KRAMDOWN" 1 "February 2010" |
2 | .SH NAME |
3 | kramdown \- a fast, pure-Ruby Markdown-superset converter |
4 | .SH SYNOPSIS |
5 | .B kramdown |
6 | [\fIoptions\fR] |
7 | [\fIFILE\fR ...] |
8 | .SH DESCRIPTION |
9 | kramdown parses a superset of Markdown and converts it to different output formats. It is supports |
10 | standard Markdown (with some minor modifications) and various extensions like tables and definition |
11 | lists. |
12 | |
13 | If \fIFILE\fR is not specified, kramdown reads from the standard input. The result is written to the |
14 | standard output. |
15 | |
16 | There are two sets of options that kramdown accepts: The first one includes the options that are |
17 | used directly by the kramdown binary. The second set of options controls how kramdown parses and |
18 | converts its input. |
19 | .SH OPTIONS |
20 | .TP |
21 | .B \-f, \-\-format ARG |
22 | Specify the output format. Available output formats: html (this is the default) or latex. |
23 | .TP |
24 | .B \-v, \-\-version |
25 | Show the version of kramdown. |
26 | .TP |
27 | .B \-h, \-\-help |
28 | Show the help. |
29 | |
30 | .SH KRAMDOWN OPTIONS |
31 | |
32 | .TP |
33 | .B \-\-template ARG |
34 | |
35 | The name of an ERB template file that should be used to wrap the output |
36 | |
37 | This is used to wrap the output in an environment so that the output can |
38 | be used as a stand-alone document. For example, an HTML template would |
39 | provide the needed header and body tags so that the whole output is a |
40 | valid HTML file. If no template is specified, the output will be just |
41 | the converted text. |
42 | |
43 | When resolving the template file, the given template name is used first. |
44 | If such a file is not found, the converter extension is appended. If the |
45 | file still cannot be found, the templates name is interpreted as a |
46 | template name that is provided by kramdown (without the converter |
47 | extension). |
48 | |
49 | kramdown provides a default template named 'default' for each converter. |
50 | |
51 | Default: '' |
52 | Used by: all converters |
53 | |
54 | |
55 | .TP |
56 | .B \-\-[no\-]auto_ids |
57 | |
58 | Use automatic header ID generation |
59 | |
60 | If this option is `true`, ID values for all headers are automatically |
61 | generated if no ID is explicitly specified. |
62 | |
63 | Default: true |
64 | Used by: HTML/Latex converter |
65 | |
66 | |
67 | .TP |
68 | .B \-\-auto_id_prefix ARG |
69 | |
70 | Prefix used for automatically generated heaer IDs |
71 | |
72 | This option can be used to set a prefix for the automatically generated |
73 | header IDs so that there is no conflict when rendering multiple kramdown |
74 | documents into one output file separately. The prefix should only |
75 | contain characters that are valid in an ID! |
76 | |
77 | Default: '' |
78 | Used by: HTML/Latex converter |
79 | |
80 | |
81 | .TP |
82 | .B \-\-[no\-]parse_block_html |
83 | |
84 | Process kramdown syntax in block HTML tags |
85 | |
86 | If this option is `true`, the kramdown parser processes the content of |
87 | block HTML tags as text containing block level elements. Since this is |
88 | not wanted normally, the default is `false`. It is normally better to |
89 | selectively enable kramdown processing via the markdown attribute. |
90 | |
91 | Default: false |
92 | Used by: kramdown parser |
93 | |
94 | |
95 | .TP |
96 | .B \-\-[no\-]parse_span_html |
97 | |
98 | Process kramdown syntax in span HTML tags |
99 | |
100 | If this option is `true`, the kramdown parser processes the content of |
101 | span HTML tags as text containing span level elements. |
102 | |
103 | Default: true |
104 | Used by: kramdown parser |
105 | |
106 | |
107 | .TP |
108 | .B \-\-[no\-]html_to_native |
109 | |
110 | Convert HTML elements to native elements |
111 | |
112 | If this option is `true`, the parser converts HTML elements to native |
113 | elements. For example, when parsing `<em>hallo</em>` the emphasis tag |
114 | would normally be converted to an `:html` element with tag type `:em`. |
115 | If `html_to_native` is `true`, then the emphasis would be converted to a |
116 | native `:em` element. |
117 | |
118 | This is useful for converters that cannot deal with HTML elements. |
119 | |
120 | Default: false |
121 | Used by: kramdown parser |
122 | |
123 | |
124 | .TP |
125 | .B \-\-footnote_nr ARG |
126 | |
127 | The number of the first footnote |
128 | |
129 | This option can be used to specify the number that is used for the first |
130 | footnote. |
131 | |
132 | Default: 1 |
133 | Used by: HTML converter |
134 | |
135 | |
136 | .TP |
137 | .B \-\-filter_html ARG |
138 | |
139 | NOTE: This option is deprecated and will be removed in a future release! |
140 | |
141 | An array of HTML tags that should be filtered from the output |
142 | |
143 | The value can either be specified as array or as a space separated |
144 | string (which will be converted to an array). All HTML tags that are |
145 | listed in the array will be filtered from the output, i.e. only their |
146 | contents is used. This applies only to HTML tags found in the initial |
147 | document. |
148 | |
149 | Default: [] |
150 | Used by: HTML converter |
151 | |
152 | |
153 | .TP |
154 | .B \-\-coderay_wrap ARG |
155 | |
156 | Defines how the highlighted code should be wrapped |
157 | |
158 | The possible values are :span, :div or nil. |
159 | |
160 | Default: :div |
161 | Used by: HTML converter |
162 | |
163 | |
164 | .TP |
165 | .B \-\-coderay_line_numbers ARG |
166 | |
167 | Defines how and if line numbers should be shown |
168 | |
169 | The possible values are :table, :inline, :list or nil. If this option is |
170 | nil, no line numbers are shown. |
171 | |
172 | Default: :inline |
173 | Used by: HTML converter |
174 | |
175 | |
176 | .TP |
177 | .B \-\-coderay_line_number_start ARG |
178 | |
179 | The start value for the line numbers |
180 | |
181 | Default: 1 |
182 | Used by: HTML converter |
183 | |
184 | |
185 | .TP |
186 | .B \-\-coderay_tab_width ARG |
187 | |
188 | The tab width used in highlighted code |
189 | |
190 | Used by: HTML converter |
191 | |
192 | |
193 | .TP |
194 | .B \-\-coderay_bold_every ARG |
195 | |
196 | Defines how often a line number should be made bold |
197 | |
198 | Default: 10 |
199 | Used by: HTML converter |
200 | |
201 | |
202 | .TP |
203 | .B \-\-coderay_css ARG |
204 | |
205 | Defines how the highlighted code gets styled |
206 | |
207 | Possible values are :class (CSS classes are applied to the code |
208 | elements, one must supply the needed CSS file) or :style (default CSS |
209 | styles are directly applied to the code elements). |
210 | |
211 | Default: style |
212 | Used by: HTML converter |
213 | |
214 | |
215 | .SH SEE ALSO |
216 | The kramdown website, http://kramdown.rubyforge.org/ for more information, especially on the support |
217 | input syntax. |
218 | .SH AUTHOR |
219 | kramdown was written by Thomas Leitner <t_leitner@gmx.at>. |
220 | .PP |
221 | This manual page was written by Thomas Leitner <t_leitner@gmx.at>. |
222 |