Scroll to navigation

CM2HTML(1) recommonmark Python package CM2HTML(1)

NAME

cm2html - convert CommonMark file to HTML document

SYNOPSIS

cm2html [options] [<source> [<destination>]]

DESCRIPTION

Generate html document from markdown sources. Reads from <source> (default is stdin) and writes to <destination> (default is stdout). See <http://docutils.sf.net/docs/user/config.html> for the full reference.

OPTIONS

General Docutils Options:

Specify the document title as metadata.
Include a "Generated by Docutils" credit and link.
Do not include a generator credit.
Include the date at the end of the document (UTC).
Include the time & date (UTC).
Do not include a datestamp of any kind.
Include a "View document source" link.
Use <URL> for a source link; implies --source-link.
Do not include a "View document source" link.
Link from section headers to TOC entries. (default)
Link from section headers to the top of the TOC.
Disable backlinks to the table of contents.
Link from footnotes/citations to references. (default)
Disable backlinks from footnotes and citations.
Enable section numbering by Docutils. (default)
Disable section numbering by Docutils.
Remove comment elements from the document tree.
Leave comment elements in the document tree. (default)
Remove all elements with classes="<class>" from the document tree. Warning: potentially dangerous; use with caution. (Multiple-use option.)
Remove all classes="<class>" attributes from elements in the document tree. Warning: potentially dangerous; use with caution. (Multiple-use option.)
Report system messages at or higher than <level>: "info" or "1", "warning"/"2" (default), "error"/"3", "severe"/"4", "none"/"5"
Report all system messages. (Same as "--report=1".)
Report no system messages. (Same as "--report=5".)
Halt execution at system messages at or above <level>. Levels as in --report. Default: 4 (severe).
Halt at the slightest problem. Same as "--halt=info".
Enable a non-zero exit status for non-halting system messages at or above <level>. Default: 5 (disabled).
Enable debug-level system messages and diagnostics.
Disable debug output. (default)
Send the output of system messages to <file>.
Enable Python tracebacks when Docutils is halted.
Disable Python tracebacks. (default)
Specify the encoding and optionally the error handler of input text. Default: <locale-dependent>:strict.
Specify the error handler for undecodable characters. Choices: "strict" (default), "ignore", and "replace".
Specify the text encoding and optionally the error handler for output. Default: UTF-8:strict.
Specify error handler for unencodable output characters; "strict" (default), "ignore", "replace", "xmlcharrefreplace", "backslashreplace".
Specify text encoding and error handler for error output. Default: ascii:backslashreplace.
Specify the error handler for unencodable characters in error output. Default: backslashreplace.
Specify the language (as BCP 47 language tag). Default: en.
Write output file dependencies to <file>.
Read configuration settings from <file>, if it exists.
Show this program's version number and exit.
Show this help message and exit.

Standalone Reader:

Disable the promotion of a lone top-level section title to document title (and subsequent section title to document subtitle promotion; enabled by default).
Disable the bibliographic field list transform (enabled by default).
Activate the promotion of lone subsection titles to section subtitles (disabled by default).
Deactivate the promotion of lone subsection titles.

HTML-Specific Options:

Specify the template file (UTF-8 encoded). Default is "/usr/share/docutils/writers/html4css1/template.txt".
Comma separated list of stylesheet URLs. Overrides previous --stylesheet and --stylesheet-path settings.
Comma separated list of stylesheet paths. Relative paths are expanded if a matching file is found in the --stylesheet-dirs. With --link-stylesheet, the path is rewritten relative to the output HTML file. Default: "html4css1.css"
Embed the stylesheet(s) in the output HTML file. The stylesheet files must be accessible during processing. This is the default.
Link to the stylesheet(s) in the output HTML file. Default: embed stylesheets.
Comma-separated list of directories where stylesheets are found. Used by --stylesheet-path when expanding relative path arguments. Default: "['.', '/usr/share/docutils/writers/html4css1']"
Specify the initial header level. Default is 1 for "<h1>". Does not affect document title & subtitle (see --no-doc-title).
Specify the maximum width (in characters) for onecolumn field names. Longer field names will span an entire row of the table used to render the field list. Default is 14 characters. Use 0 for "no limit".
Specify the maximum width (in characters) for options in option lists. Longer options will span an entire row of the table used to render the option list. Default is 14 characters. Use 0 for "no limit".
Format for footnote references: one of "superscript" or "brackets". Default is "brackets".
Format for block quote attributions: one of "dash" (em-dash prefix), "parentheses"/"parens", or "none". Default is "dash".
Remove extra vertical whitespace between items of "simple" bullet lists and enumerated lists. Default: enabled.
Disable compact simple bullet and enumerated lists.
Remove extra vertical whitespace between items of simple field lists. Default: enabled.
Disable compact simple field lists.
Added to standard table classes. Defined styles: "borderless". Default: ""
Math output format, one of "MathML", "HTML", "MathJax" or "LaTeX". Default: "HTML math.css"
Omit the XML declaration. Use with caution.
Obfuscate email addresses to confuse harvesters while still keeping email links usable with standardscompliant browsers.

AUTHOR

Steve Genoud and Luca Barbato

COPYRIGHT

Copyright (C) 2014 Steve Genoud and Luca Barbato

October 2016 recommonmark (Debian 0.4.0+ds-2)