markdown(1) [debian man page]
MARKDOWN(1) BSD General Commands Manual MARKDOWN(1) NAME
markdown -- text to html conversion tool SYNOPSIS
markdown [-d] [-T] [-V] [-b url-base] [-C prefix] [-F bitmap] [-f flags] [-o file] [-s text] [-t text] [textfile] DESCRIPTION
The markdown utility reads the markdown(7)-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. As an example, the option -f nolinks,smarty tells markdown 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) -V Show the version# and compile-time configuration data. If the version includes the string DEBUG, markdown was configured with memory allocation debugging. If the version includes the string TAB, markdown was configured to use the specified tabstop. -VV Show the version#, the compile-time configuration, and the run-time configuration. -o file Write the generated html to file. -t text Use mkd_text(3) 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 markdown utility exits 0 on success, and >0 if an error occurs. SEE ALSO
markdown(3), markdown(7), mkd-extensions(7). AUTHOR
David Parsons (orc@pell.chi.il.us) MASTODON
January 7, 2008 MASTODON
Check Out this Related Man Page
MKD-EXTENSIONS(7) BSD Miscellaneous Information Manual MKD-EXTENSIONS(7) NAME
mkd-extensions -- Extensions to the Markdown text formatting syntax DESCRIPTION
This version of markdown has been extended in a few ways by extending existing markup, creating new markup from scratch, and borrowing markup from other markup languages. Image dimensions Markdown embedded images have been extended to allow specifying the dimensions of the image by adding a new argument =/height/x/width/ to the link description. The new image syntax is  pseudo-protocols Five pseudo-protocols have been added to links id: The alt text is marked up and written to the output, wrapped with <a id=id> and </a>. class: The alt text is marked up and written to the output, wrapped with <span class=class> and </span>. raw: The title is written -- with no further processing -- to the output. The alt text is discarded. abbr: The alt text is marked up and written to the output, wrapped with <abbr title=abbr> and </abbr>. lang: The alt text s marked up and written to the output, wrapped with <span lang=lang> and </span>. Pandoc headers The markdown source document can have a 3-line Pandoc header in the format of % title % author(s) % date which will be made available to the mkd_doc_title(), mkd_doc_author(), and mkd_doc_date() functions. Definition lists A definition list item is defined as =tag= description (that is a =, followed by text, another =, a newline, 4 spaces of intent, and then more text.) Alternatively, definition list items are defined as tag : description (This is the format that PHP Markdown Extra uses.) embedded stylesheets Stylesheets may be defined and modified in a <style> block. A style block is parsed like any other block level html; <style> starting on column 1, raw html (or, in this case, css) following it, and either ending with a </style> at the end of the line or a </style> at the begin- ning of a subsequent line. Be warned that style blocks work like footnote links -- no matter where you define them they are valid for the entire document. relaxed emphasis The rules for emphasis are changed so that a single _ will not count as a emphasis character if it's in the middle of a word. This is pri- marily for documenting code, if you don't wish to have to backquote all code references. alpha lists Alphabetic lists (like regular numeric lists, but with alphabetic items) are supported. So: a. this b. is c. an alphabetic d. list will produce: <ol type=a> <li>this</li> <li>is</li> <li>an alphabetic</li> <li>list</li> </ol> tables PHP Markdown Extra tables are supported; input of the form header|header ------|------ text | text will produce: <table> <thead> <tr> <th>header</th> <th>header</th> </tr> </thead> <tbody> <tr> <td>text</td> <td>text</td> </tr> </tbody> </table> The dashed line can also contain : characters for formatting; if a : is at the start of a column, it tells discount to align the cell con- tents to the left; if it's at the end, it aligns right, and if there's one at the start and at the end, it centers. strikethrough A strikethrough syntax is supported in much the same way that ` is used to define a section of code. If you enclose text with two or more tildes, such as ~~erased text~~ it will be written as <del>erased text</del>. Like code sections, you may use as many ~ as you want, but there must be as many starting tildes as closing tildes. markdown extra-style footnotes PHP Markdown Extra footnotes are supported. If a footnote link begins with a ^, the first use of that footnote will generate a link down to the bottom of the rendered document, which will contain a numbered footnote with a link back to where the footnote was called. AUTHOR
David Parsons http://www.pell.portland.or.us/~orc/ SEE ALSO
markdown(1), markdown(3), mkd-callbacks(3), mkd-functions(3), mkd-line(3). http://daringfireball.net/projects/markdown http://michelf.com/projects/php-markdown MASTODON
Dec 22, 2007 MASTODON