NAME

markdown - text to html conversion tool

SYNOPSIS

[-d ] [-T ] [-V ] [-b url-base ] [-C prefix ] [-F bitmap ] [-f flags ] [-n ] [-o file ] [-S ] [-s text ] [-t text ] [textfile ]

DESCRIPTION

The utility reads the markdown(7)Ns-formatted textfile (or stdin if not specified,) compiles it, and writes the html output to stdout.

The options are as follows:

-b url-base
Links in source beginning with / will be prefixed with url-base in the output.
-C
When processing markdown extra-style footnotes, use the given prefix instead of the default of fn
-d
Instead of writing the html file, dump a parse tree to stdout.
-f flags
Set or clear various translation flags. The flags are in a comma-delimited list, with an optional + (enable), - (disable), or no (disable) lprefix on each flag.

links
Allow links.
image
Allow images.
smarty
Enable smartypants.
pants
Enable smartypants.
html
Allow raw html.
strict
Disable superscript, strikethrough & relaxed emphasis.
ext
Enable pseudo-protocols.
cdata
Generate code for xml ![CDATA[...]]
superscript
Enable superscript processing.
emphasis
Emphasis happens everywhere
tables
Don't process PHP Markdown Extra tables.
del
Enable ~~strikethrough~~
strikethrough
Enable ~~strikethrough~~
toc
Enable table-of-contents processing.
1.0
Compatibility with MarkdownTest_1.0
autolink
Make http://foo.com a link even without <>
safelink
Paranoid check for link protocol.
header
Process pandoc-style header blocks.
tabstop
Expand tabs to 4 spaces.
divquote
Allow >%class% blocks.
alphalist
Allow alphabetic lists.
definitionlist
Allow definition lists.
footnote
Allow markdown extra-style footnotes.
styles
Extract <style> blocks from the output.

As an example, the option -f nolinks,smarty tells to not allow <a tags, and to do smarty pants processing.

-F bitmap
Set translation flags. Bitmap is a bit map of the various configuration options described in markdown(3) (the flag values are defined in mkdio.h
-n
Don't write generated html.
-o file
Write the generated html to file
-S
output <style> blocks.
-V
Show the version# and compile-time configuration data.

If the version includes the string DEBUG was configured with memory allocation debugging.

If the version includes the string TAB was configured to use the specified tabstop.

-VV
Show the version#, the compile-time configuration, and the run-time configuration.
-t text
Use mkd_text3 to format text instead of processing stdin with the markdown(3) function.
-T
If run with the table-of-content flag on, dump the table of contents before the formatted text.
-s text
Use the markdown(3) function to format text

RETURN VALUES

The utility exits 0 on success, and >0 if an error occurs.

SEE ALSO

markdown(3), markdown(7), mkd-extensions7.

AUTHOR

An David Parsons (orc [at] pell.portland.or.us )