Scroll to navigation

cmark-gfm(1) General Commands Manual cmark-gfm(1)


cmark - convert CommonMark formatted text with GitHub Flavored Markdown extensions to HTML


cmark-gfm [options] file*


cmark-gfm converts Markdown formatted plain text to either HTML, groff man, CommonMark XML, LaTeX, or CommonMark, using the conventions described in the CommonMark spec. It reads input from stdin or the specified files (concatenating their contents) and writes output to stdout.


Specify output format (html, man, xml, latex, commonmark).
Specify a column width to which to wrap the output. For no wrapping, use the value 0 (the default). This option currently only affects the commonmark, latex, and man renderers.
Render soft breaks (newlines inside paragraphs in the CommonMark source) as hard line breaks in the target format. If this option is specified, hard wrapping is disabled for CommonMark output, regardless of the value given with --width.
Render soft breaks as spaces. If this option is specified, hard wrapping is disabled for all output formats, regardless of the value given with --width.
Include source position attribute.
Consolidate adjacent text nodes.
Specify an extension name to use.
List available extensions and quit.
Validate UTF-8, replacing illegal sequences with U+FFFD.
Use smart punctuation. Straight double and single quotes will be rendered as curly quotes, depending on their position. -- will be rendered as an en-dash. --- will be rendered as an em-dash. ... will be rendered as ellipses.
Do not render raw HTML or potentially dangerous URLs. (Raw HTML is replaced by a placeholder comment; potentially dangerous URLs are replaced by empty strings.) Dangerous URLs are those that begin with `javascript:`, `vbscript:`, `file:`, or `data:` (except for `image/png`, `image/gif`, `image/jpeg`, or `image/webp` mime types).
Print usage information.
Print version.


John MacFarlane, Vicent Marti, Kārlis Gaņģis, Nick Wellnhofer.


CommonMark spec:

March 24, 2016 LOCAL