.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Markdent::Simple::Document 3pm" .TH Markdent::Simple::Document 3pm "2019-01-26" "perl v5.28.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Markdent::Simple::Document \- Convert Markdown to an HTML Document .SH "VERSION" .IX Header "VERSION" version 0.33 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Markdent::Simple::Document; \& \& my $mds = Markdent::Simple::Document\->new(); \& my $html = $mds\->markdown_to_html( \& title => \*(AqMy Document\*(Aq, \& markdown => $markdown, \& ); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This class provides a very simple interface for converting Markdown to a complete \s-1HTML\s0 document. .SH "METHODS" .IX Header "METHODS" This class provides the following methods: .SS "Markdent::Simple::Document\->\fBnew()\fP" .IX Subsection "Markdent::Simple::Document->new()" Creates a new Markdent::Simple::Document object. .ie n .SS "$mds\->markdown_to_html( title => $title, markdown => $markdown )" .el .SS "\f(CW$mds\fP\->markdown_to_html( title => \f(CW$title\fP, markdown => \f(CW$markdown\fP )" .IX Subsection "$mds->markdown_to_html( title => $title, markdown => $markdown )" This method turns Markdown into \s-1HTML.\s0 It accepts the following parameters: .IP "\(bu" 4 title => \f(CW$title\fR .Sp The title of the document. This is required. .IP "\(bu" 4 charset => \f(CW$charset\fR .Sp If provided, a \f(CW\*(C`\*(C'\fR tag will be added to the document's \&\f(CW\*(C`\*(C'\fR. .IP "\(bu" 4 language => \f(CW$language\fR .Sp If provided, a \*(L"lang\*(R" attribute will be added to the document's \f(CW\*(C`\*(C'\fR tag. .IP "\(bu" 4 dialects => [...] .Sp This can either be a single string or an array ref of strings containing the class names of dialects. This parameter is optional. .SH "ROLES" .IX Header "ROLES" This class does the Markdent::Role::Simple role. .SH "BUGS" .IX Header "BUGS" See Markdent for bug reporting details. .PP Bugs may be submitted at . .PP I am also usually active on \s-1IRC\s0 as 'autarch' on \f(CW\*(C`irc://irc.perl.org\*(C'\fR. .SH "SOURCE" .IX Header "SOURCE" The source code repository for Markdent can be found at . .SH "AUTHOR" .IX Header "AUTHOR" Dave Rolsky .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2019 by Dave Rolsky. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. .PP The full text of the license can be found in the \&\fI\s-1LICENSE\s0\fR file included with this distribution.