1MARKDOWN(1) BSD General Commands Manual MARKDOWN(1)
2
4 markdown — text to html conversion tool
5
7 markdown [-d] [-T] [-V] [-b url-base] [-C prefix] [-F bitmap] [-f flags]
8 [-n] [-o file] [-S] [-s text] [-t text] [textfile]
9
11 The markdown utility reads the markdown(7)-formatted textfile (or stdin
12 if not specified,) compiles it, and writes the html output to stdout.
13 The options are as follows:
15 -b url-base
17 Links in source beginning with / will be prefixed with url-base
18 in the output.
19 -C When processing markdown extra-style footnotes, use the given
21 prefix instead of the default of fn.
22 -d Instead of writing the html file, dump a parse tree to stdout.
24 -f flags
26 Set or clear various translation flags. The flags are in a
27 comma-delimited list, with an optional + (enable), - (disable),
28 or no (disable) lprefix on each flag.
29 links Allow links.
31 image Allow images.
33 smarty Enable smartypants.
35 pants Enable smartypants.
37 html Allow raw html.
39 strict Disable superscript, strikethrough & relaxed
41 emphasis.
42 ext Enable pseudo-protocols.
44 cdata Generate code for xml ![CDATA[...]].
46 superscript Enable superscript processing.
48 emphasis Emphasis happens everywhere.
50 tables Don't process PHP Markdown Extra tables.
52 del Enable ~~strikethrough~~.
54 strikethrough Enable ~~strikethrough~~.
56 toc Enable table-of-contents processing.
58 1.0 Compatibility with MarkdownTest_1.0
60 autolink Make http://foo.com a link even without <>.
62 safelink Paranoid check for link protocol.
64 header Process pandoc-style header blocks.
66 tabstop Expand tabs to 4 spaces.
68 divquote Allow >%class% blocks.
70 alphalist Allow alphabetic lists.
72 definitionlist Allow definition lists at all (default). Use
74 dldiscount and dlextra to control which syntaxes
75 are respected.
76 dldiscount Enable discount-style definition lists
78 (default).
79 dlextra Enable extra-style definition lists (not
81 default). Both styles may be enabled simultane‐
82 ously.
83 footnote Allow markdown extra-style footnotes.
85 style Extract <style> blocks from the output.
87 fencedcode Allow fenced code blocks (not default).
89 idanchor Use id= anchors for table-of-contents links
91 instead of <a name=/> (not default).
92 githubtags Allow underscore and dash in passed through ele‐
94 ment names (not default).
95 urlencodedanchor
97 Use url-encoded chars for multibyte and nonal‐
98 phanumeric chars rather than dots in toc links.
99 As an example, the option -f nolinks,smarty tells markdown to
101 not allow <a tags, and to do smarty pants processing.
102 -F bitmap
104 Set translation flags. Bitmap is a bit map of the various con‐
105 figuration options described in markdown(3) (the flag values are
106 defined in mkdio.h)
107 -n Don't write generated html.
109 -o file Write the generated html to file.
111 -S output <style> blocks.
113 -V Show the version# and compile-time configuration data.
115 If the version includes the string DEBUG, markdown was config‐
117 ured with memory allocation debugging.
118 If the version includes the string TAB, markdown was configured
120 to use the specified tabstop.
121 -VV Show the version#, the compile-time configuration, and the run-
123 time configuration.
124 -t text Use mkd_text(3) to format text instead of processing stdin with
126 the markdown(3) function.
127 -T If run with the table-of-content flag on, dump the table of con‐
129 tents before the formatted text.
130 -s text Use the markdown(3) function to format text.
132
134 The markdown utility exits 0 on success, and >0 if an error occurs.
135
137 markdown(3), markdown(7), mkd-extensions(7).
138
140 David Parsons (orc@pell.portland.or.us)
141MASTODON January 7, 2008 MASTODON