1cmark(1)                    General Commands Manual                   cmark(1)
2
3
4

NAME

6       cmark - convert CommonMark formatted text to HTML
7

SYNOPSIS

9       cmark [options] file*
10

DESCRIPTION

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

OPTIONS

18       --to, -t FORMAT
19                   Specify output format (html, man, xml, latex, commonmark).
20
21       --width WIDTH
22                   Specify a column width to which to wrap the output. For  no
23                   wrapping,  use the value 0 (the default).  This option cur‐
24                   rently only affects the commonmark, latex, and man  render‐
25                   ers.
26
27       --hardbreaks
28                   Render  soft breaks (newlines inside paragraphs in the Com‐
29                   monMark source) as hard line breaks in the  target  format.
30                   If  this option is specified, hard wrapping is disabled for
31                   CommonMark output,  regardless  of  the  value  given  with
32                   --width.
33
34       --nobreaks  Render soft breaks as spaces.  If this option is specified,
35                   hard wrapping is disabled for all output  formats,  regard‐
36                   less of the value given with --width.
37
38       --sourcepos Include source position attribute.
39
40       --validate-utf8
41                   Validate UTF-8, replacing illegal sequences with U+FFFD.
42
43       --smart     Use  smart  punctuation.  Straight double and single quotes
44                   will be rendered as curly quotes, depending on their  posi‐
45                   tion.  -- will be rendered as an en-dash.  --- will be ren‐
46                   dered as an em-dash.  ... will be rendered as ellipses.
47
48       --safe      Omit raw HTML and  potentially  dangerous  URLs  (default).
49                   Raw  HTML  is  replaced by a placeholder comment and poten‐
50                   tially dangerous URLs are replaced by empty  strings.   Po‐
51                   tentially  dangerous  URLs are those that begin with `java‐
52                   script:`, `vbscript:`, `file:`, or `data:` (except for `im‐
53                   age/png`,  `image/gif`,  `image/jpeg`, or `image/webp` mime
54                   types).
55
56       --unsafe    Render raw HTML or potentially dangerous  URLs,  overriding
57                   the default (--safe) behavior.
58
59       --help      Print usage information.
60
61       --version   Print version.
62

AUTHORS

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

SEE ALSO

67       CommonMark spec:  https://spec.commonmark.org.
68
69
70
71LOCAL                          February 11, 2020                      cmark(1)
Impressum