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
HTML::WikiConverter::Markdown(3pm) User Contributed Perl Documentation HTML::WikiConverter::Markdown(3pm) NAME
HTML::WikiConverter::Markdown - Convert HTML to Markdown markup SYNOPSIS
use HTML::WikiConverter; my $wc = new HTML::WikiConverter( dialect => 'Markdown' ); print $wc->html2wiki( $html ); DESCRIPTION
This module contains rules for converting HTML into Markdown markup. You should not use this module directly; HTML::WikiConverter is the entry point for html->wiki conversion (eg, see synopsis above). See HTML::WikiConverter for additional usage details. ATTRIBUTES
In addition to the regular set of attributes recognized by the HTML::WikiConverter constructor, this dialect also accepts the following attributes that can be passed into the "new()" constructor. See "ATTRIBUTES" in HTML::WikiConverter for usage details. header_style Possible values: 'setext', 'atx'. Determines how headers "h1"-"h6" will be formatted. See <http://daringfireball.net/projects/markdown/syntax#header> for more information. Default is 'atx'. link_style Possible values: 'inline', 'reference'. See <http://daringfireball.net/projects/markdown/syntax#link> for more information. Default is 'reference'. force_inline_anchor_links Possible values: 0, 1. If enabled, links to anchors within the same page (eg, "#some-anchor") will always produce inline Markdown links, even under reference link style. This might be useful for building tables of contents. Default is 0. image_style Possible values: 'inline', 'reference'. See <http://daringfireball.net/projects/markdown/syntax#img> for more information. Default is 'reference'. image_tag_fallback Possible values: 0, 1. Markdown's image markup does not support image dimensions. If "image_tag_fallback" is enabled, image tags containing dimensional information (ie, width or height) will not be converted into Markdown markup. Rather, they will be roughly preserved in their HTML form. Default is 1. unordered_list_style Possible values: 'asterisk', 'plus', 'dash'. See <http://daringfireball.net/projects/markdown/syntax#list> for more information. Default is 'asterisk'. ordered_list_style Possible values: 'sequential', 'one-dot'. Markdown supports two different markups for ordered lists. Sequential style gives each list element its own ordinal number (ie, '1.', '2.', '3.', etc.). One-dot style gives each list element the same ordinal number (ie, '1.'). See <http://daringfireball.net/projects/markdown/syntax#list> for more information. Default is 'sequential'. AUTHOR
David J. Iberri, "<diberri at cpan.org>" BUGS
Please report any bugs or feature requests to "bug-html-wikiconverter-markdown at rt.cpan.org", or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=HTML-WikiConverter-Markdown>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. SUPPORT
You can find documentation for this module with the perldoc command. perldoc HTML::WikiConverter::Markdown You can also look for information at: o AnnoCPAN: Annotated CPAN documentation <http://annocpan.org/dist/HTML-WikiConverter-Markdown> o CPAN Ratings <http://cpanratings.perl.org/d/HTML-WikiConverter-Markdown> o RT: CPAN's request tracker <http://rt.cpan.org/NoAuth/Bugs.html?Dist=HTML-WikiConverter-Markdown> o Search CPAN <http://search.cpan.org/dist/HTML-WikiConverter-Markdown> COPYRIGHT &; LICENSE Copyright 2006 David J. Iberri, all rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. perl v5.10.0 2008-07-13 HTML::WikiConverter::Markdown(3pm)