NAME¶

kramdown - a fast, pure-Ruby Markdown-superset converter

SYNOPSIS¶

kramdown [ options] [ FILE ...]

DESCRIPTION¶

kramdown is primarily used for parsing a superset of Markdown and converting it to different output formats. It supports standard Markdown (with some minor modifications) and various extensions like tables and definition lists. Due to its modular architecture it also allows other input formats than Markdown, for example, HTML. If FILE is not specified, kramdown reads from the standard input. The result is written to the standard output. There are two sets of options that kramdown accepts: The first one includes the options that are used directly by the kramdown binary. The second set of options controls how kramdown parses and converts its input.

OPTIONS¶

-i, --input ARG

Specify the input format. Available input formats: kramdown (this is the default) or html.

-o, --output ARG

Specify one or more output formats separated by commas: html (default), kramdown, latex or remove_html_tags.

-v, --version

Show the version of kramdown.

-h, --help

Show the help.

 

KRAMDOWN OPTIONS¶

--[no-]remove-span-html-tags

 

Remove span HTML tags

 

If this option is `true`, the RemoveHtmlTags converter removes span HTML tags.

 

Default: false Used by: RemoveHtmlTags converter

 

 

--coderay-tab-width ARG

 

The tab width used in highlighted code

 

Used by: HTML converter

 

 

--toc-levels ARG

 

Defines the levels that are used for the table of contents

 

The individual levels can be specified by separating them with commas (e.g. 1,2,3) or by using the range syntax (e.g. 1..3). Only the specified levels are used for the table of contents.

 

Default: 1..6 Used by: HTML/Latex converter

 

 

--[no-]parse-span-html

 

Process kramdown syntax in span HTML tags

 

If this option is `true`, the kramdown parser processes the content of span HTML tags as text containing span-level elements.

 

Default: true Used by: kramdown parser

 

 

--coderay-bold-every ARG

 

Defines how often a line number should be made bold

 

Default: 10 Used by: HTML converter

 

 

--line-width ARG

 

Defines the line width to be used when outputting a document

 

Default: 72 Used by: kramdown converter

 

 

--[no-]html-to-native

 

Convert HTML elements to native elements

 

If this option is `true`, the parser converts HTML elements to native elements. For example, when parsing `<em>hallo</em>` the emphasis tag would normally be converted to an `:html` element with tag type `:em`. If `html_to_native` is `true`, then the emphasis would be converted to a native `:em` element.

 

This is useful for converters that cannot deal with HTML elements.

 

Default: false Used by: kramdown parser

 

 

--coderay-css ARG

 

Defines how the highlighted code gets styled

 

Possible values are :class (CSS classes are applied to the code elements, one must supply the needed CSS file) or :style (default CSS styles are directly applied to the code elements).

 

Default: style Used by: HTML converter

 

 

--latex-headers ARG

 

Defines the LaTeX commands for different header levels

 

The commands for the header levels one to six can be specified by separating them with commas.

 

Default: section,subsection,subsubsection,paragraph,subparagraph,subsubparagraph Used by: Latex converter

 

 

--footnote-nr ARG

 

The number of the first footnote

 

This option can be used to specify the number that is used for the first footnote.

 

Default: 1 Used by: HTML converter

 

 

--template ARG

 

The name of an ERB template file that should be used to wrap the output

 

This is used to wrap the output in an environment so that the output can be used as a stand-alone document. For example, an HTML template would provide the needed header and body tags so that the whole output is a valid HTML file. If no template is specified, the output will be just the converted text.

 

When resolving the template file, the given template name is used first. If such a file is not found, the converter extension is appended. If the file still cannot be found, the templates name is interpreted as a template name that is provided by kramdown (without the converter extension).

 

kramdown provides a default template named 'document' for each converter.

 

Default: '' Used by: all converters

 

 

--coderay-default-lang ARG

 

Sets the default language for highlighting.

 

If no language is set for a code block, the default language is used instead. The value has to be one of the languages supported by coderay or nil if no default language should be used.

 

Default: nil Used by: HTML converter

 

 

--coderay-line-numbers ARG

 

Defines how and if line numbers should be shown

 

The possible values are :table, :inline or nil. If this option is nil, no line numbers are shown.

 

Default: :inline Used by: HTML converter

 

 

--smart-quotes ARG

 

Defines the HTML entity names or code points for smart quote output

 

The entities identified by entity name or code point that should be used for, in order, a left single quote, a right single quote, a left double and a right double quote are specified by separating them with commas.

 

Default: lsquo,rsquo,ldquo,rdquo Used by: HTML/Latex converter

 

 

--coderay-wrap ARG

 

Defines how the highlighted code should be wrapped

 

The possible values are :span, :div or nil.

 

Default: :div Used by: HTML converter

 

 

--entity-output ARG

 

Defines how entities are output

 

The possible values are :as_input (entities are output in the same form as found in the input), :numeric (entities are output in numeric form), :symbolic (entities are output in symbolic form if possible) or :as_char (entities are output as characters if possible, only available on Ruby 1.9).

 

Default: :as_char Used by: HTML converter, kramdown converter

 

 

--auto-id-prefix ARG

 

Prefix used for automatically generated heaer IDs

 

This option can be used to set a prefix for the automatically generated header IDs so that there is no conflict when rendering multiple kramdown documents into one output file separately. The prefix should only contain characters that are valid in an ID!

 

Default: '' Used by: HTML/Latex converter

 

 

--[no-]remove-block-html-tags

 

Remove block HTML tags

 

If this option is `true`, the RemoveHtmlTags converter removes block HTML tags.

 

Default: true Used by: RemoveHtmlTags converter

 

 

--coderay-line-number-start ARG

 

The start value for the line numbers

 

Default: 1 Used by: HTML converter

 

 

--[no-]auto-ids

 

Use automatic header ID generation

 

If this option is `true`, ID values for all headers are automatically generated if no ID is explicitly specified.

 

Default: true Used by: HTML/Latex converter

 

 

--[no-]parse-block-html

 

Process kramdown syntax in block HTML tags

 

If this option is `true`, the kramdown parser processes the content of block HTML tags as text containing block-level elements. Since this is not wanted normally, the default is `false`. It is normally better to selectively enable kramdown processing via the markdown attribute.

 

Default: false Used by: kramdown parser

 

 

EXIT STATUS¶

The exit status is 0 if no error happened. Otherwise it is 1.

SEE ALSO¶

The kramdown website, http://kramdown.rubyforge.org/ for more information, especially on the supported input syntax.

AUTHOR¶

kramdown was written by Thomas Leitner <t_leitner@gmx.at>. This manual page was written by Thomas Leitner <t_leitner@gmx.at>.