1Text::Markdown(3)     User Contributed Perl Documentation    Text::Markdown(3)
2
3
4

NAME

6       Markdown
7

SYNOPSIS

9           use Text::Markdown 'markdown';
10           my $html = markdown($text);
11
12           use Text::Markdown 'markdown';
13           my $html = markdown( $text, {
14               empty_element_suffix => '>',
15               tab_width => 2
16           } );
17
18           use Text::Markdown;
19           my $m = Text::Markdown->new;
20           my $html = $m->markdown($text);
21
22           use Text::Markdown;
23           my $m = Text::Markdown->new;
24           my $html = $m->markdown( $text, {
25               empty_element_suffix => '>',
26               tab_width => 2
27           } );
28

DESCRIPTION

30       Markdown is a text-to-HTML filter; it translates an easy-to-read /
31       easy-to-write structured text format into HTML. Markdown's text format
32       is most similar to that of plain text email, and supports features such
33       as headers, *emphasis*, code blocks, blockquotes, and links.
34
35       Markdown's syntax is designed not as a generic markup language, but
36       specifically to serve as a front-end to (X)HTML. You can  use span-
37       level HTML tags anywhere in a Markdown document, and you can use block
38       level HTML tags (like <div> and <table> as well).
39
40       For more information about Markdown's syntax, see:
41
42           http://daringfireball.net/projects/markdown/
43

BUGS

45       To file bug reports or feature requests (other than topics listed in
46       the Caveats section above) please send email to:
47
48           support@daringfireball.net
49
50       Please include with your report: (1) the example input; (2) the output
51       you expected; (3) the output Markdown actually produced.
52

VERSION HISTORY

54       See the readme file for detailed release notes for this version.
55
56       1.0.1 - 14 Dec 2004
57
58       1.0 - 28 Aug 2004
59

AUTHOR

61           John Gruber
62           http://daringfireball.net
63
64           PHP port and other contributions by Michel Fortin
65           http://michelf.com
66

68       Copyright (c) 2003-2004 John Gruber <http://daringfireball.net/> All
69       rights reserved.
70
71       Redistribution and use in source and binary forms, with or without mod‐
72       ification, are permitted provided that the following conditions are
73       met:
74
75       * Redistributions of source code must retain the above copyright
76       notice,
77         this list of conditions and the following disclaimer.
78
79       * Redistributions in binary form must reproduce the above copyright
80         notice, this list of conditions and the following disclaimer in the
81         documentation and/or other materials provided with the distribution.
82
83       * Neither the name "Markdown" nor the names of its contributors may
84         be used to endorse or promote products derived from this software
85         without specific prior written permission.
86
87       This software is provided by the copyright holders and contributors "as
88       is" and any express or implied warranties, including, but not limited
89       to, the implied warranties of merchantability and fitness for a partic‐
90       ular purpose are disclaimed. In no event shall the copyright owner or
91       contributors be liable for any direct, indirect, incidental, special,
92       exemplary, or consequential damages (including, but not limited to,
93       procurement of substitute goods or services; loss of use, data, or
94       profits; or business interruption) however caused and on any theory of
95       liability, whether in contract, strict liability, or tort (including
96       negligence or otherwise) arising in any way out of the use of this
97       software, even if advised of the possibility of such damage.
98
99
100
101perl v5.8.8                       2007-07-04                 Text::Markdown(3)
Impressum