NAME Text::MultiMarkdown - Convert MultiMarkdown syntax to (X)HTML SYNOPSIS use Text::MultiMarkdown 'markdown'; my $html = markdown($text); use Text::MultiMarkdown 'markdown'; my $html = markdown( $text, { empty_element_suffix => '>', tab_width => 2, use_wikilinks => 1, } ); use Text::MultiMarkdown; my $m = Text::MultiMarkdown->new; my $html = $m->markdown($text); use Text::MultiMarkdown; my $m = Text::MultiMarkdown->new( empty_element_suffix => '>', tab_width => 2, use_wikilinks => 1, ); my $html = $m->markdown( $text ); DESCRIPTION Markdown is a text-to-HTML filter; it translates an easy-to-read / easy-to-write structured text format into HTML. Markdown's text format is most similar to that of plain text email, and supports features such as headers, *emphasis*, code blocks, blockquotes, and links. Markdown's syntax is designed not as a generic markup language, but specifically to serve as a front-end to (X)HTML. You can use span-level HTML tags anywhere in a Markdown document, and you can use block level HTML tags (like
and as well). SYNTAX For more information about Markdown's syntax, see: http://daringfireball.net/projects/markdown/ This module implements MultiMarkdown, which is an extension to Markdown.. This is documented at: http://michelf.com/projects/php-markdown/extra/ and http://fletcherpenney.net/MultiMarkdown/ This documentation is going to be moved/copied into this module for clearer reading in a future release.. OPTIONS MultiMarkdown supports a number of options to it's processor which control the behavior of the output document. These options can be supplied to the constructor, on in a hash with the individual calls to the markdown method. See the synopsis for examples of both of the above styles. The options for the processor are: use_metadata Controls the metadata options below. strip_metadata Not implemented yet. empty element suffix This option can be used to generate normal HTML output. By default, it is ' />', which is xHTML, change to '>' for normal HTML. A number of possible items of metadata can also be supplied as options. Note that if the use_metadata is true then the metadata in the document will overwrite the settings on command line. Metadata options supported are: document_format use_wikilinks base_url METADATA MultiMarkdown supports the concept of 'metadata', which allows you to specify a number of formatting options within the document itself. Metadata should be placed in the top few lines of a file, on value per line as colon separated key/value pairs. The metadata should be separated from the document with a blank line. Most metadata keys are also supported as options to the constructor, or options to the markdown method itself. (Note, as metadata, keys contain space, whereas options the keys are underscore separated.) You can attach arbitrary metadata to a document, which is output in HTML tags if unknown, see t/11document_format.t for more info. A list of 'known' metadata keys, and their effects are listed below: document format If set to 'complete', MultiMarkdown will render an entire xHTML page, otherwise it will render a document fragment css Sets a CSS file for the file, if in 'complete' document format. title Sets the page title, if in 'complete' document format. use wikilinks If set to '1' or 'on', causes links that are WikiWords to automatically be processed into links. base url This is the base URL for referencing wiki pages. In this is not supplied, all wiki links are relative. METHODS new A very simple constructor. markdown The main function as far as the outside world is concerned. See the SYNOPSIS for details on use. _Markdown The main function (internal use only). Header2Label Internal use only. xhtmlMetaData Internal use only. textMetaData Internal use only. NOTICE Warning: this code is messy and does not adhere to any consistent set of code guidelines; this is not because of the original quality of the code, which is far above what I can pretend to be capable of creating, but because of the various patching and diffing steps in between and the incomplete translation of the original code into a module. BUGS To file bug reports or feature requests (other than topics listed in the Caveats section above) please send email to: support@daringfireball.net (for Markdown issues) fletcher@freeshell.org (for MultiMarkdown issues) kulp@cpan.org, bobtfish@bobtfish.net (for Text::MultiMarkdown issues) Please include with your report: (1) the example input; (2) the output you expected; (3) the output Markdown actually produced. VERSION HISTORY See the Changes file for detailed release notes for this version. AUTHOR John Gruber http://daringfireball.net/ PHP port and other contributions by Michel Fortin http://michelf.com/ MultiMarkdown changes by Fletcher Penney http://fletcher.freeshell.org/ CPAN Module Text::MultiMarkdown (based on Text::Markdown by Sebastian Riedel) by Darren Kulp & Tomas Doran http://kulp.ch/ & http://www.bobtfish.net/ COPYRIGHT AND LICENSE Original Code Copyright (c) 2003-2004 John Gruber All rights reserved. MultiMarkdown changes Copyright (c) 2005-2006 Fletcher T. Penney All rights reserved. Text::MultiMarkdown changes Copyright (c) 2006-2008 Darren Kulp and Tomas Doran Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name "Markdown" nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. This software is provided by the copyright holders and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright owner or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.