.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" 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 .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . 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 "DR::SunDown 3pm" .TH DR::SunDown 3pm 2024-01-10 "perl v5.38.2" "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 DR::SunDown \- perl bindings for sundown .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 3 \& use DR::SunDown; \& my $markdown = \`cat README.markdown\`; \& my $html = markdown2html $markdown; .Ve .SS utf8 .IX Subsection "utf8" The converter returns utf8\-strings if it receives utf8\-strings. .PP .Vb 1 \& use Encode \*(Aqencode\*(Aq, \*(Aqdecode\*(Aq; \& \& # $string is encoded utf8 \& my $string = markdown2html encode utf8 => $data; \& \& # $string and $data have the same utf8 flag \& my $string = markdown2html $data; \& \& utf8::decode( $data ) if utf8::is_utf8( $data ); \& # $string is decoded utf8 \& my $string = markdown2html $data; .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" The library is a perl binding for C\-library sundown . .SH EXPORTS .IX Header "EXPORTS" .SS markdown2html(TEXT) .IX Subsection "markdown2html(TEXT)" Converts markdown text to html. .SH AUTHOR .IX Header "AUTHOR" .Vb 1 \& Dmitry E. Oboukhov .Ve .SH LICENSE .IX Header "LICENSE" This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.