Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
73 lines (52 sloc) 2.11 KB
NAME
Pod::Markdown - Convert POD to Markdown
SYNOPSIS
my $parser = Pod::Markdown->new;
$parser->parse_from_filehandle(\*STDIN);
print $parser->as_markdown;
DESCRIPTION
This module subclasses Pod::Parser and converts POD to Markdown.
METHODS
"initialize"
Initializes a newly constructed object.
"as_markdown"
Returns the parsed POD as Markdown. Takes named arguments. If the
"with_meta" argument is given a positive value, meta tags are
generated as well.
"command"
Handles POD command paragraphs, denoted by a line beginning with
"=".
"verbatim"
Handles verbatim text.
"textblock"
Handles normal blocks of POD.
"interior_sequence"
Handles interior sequences in POD. An interior sequence is an
embedded command within a block of text which appears as a command
name - usually a single uppercase character - followed immediately
by a string of text which is enclosed in angle brackets.
BUGS AND LIMITATIONS
* Doesn't create pure Markdown texts.
* The links to manpages are incomplete.
Please report any bugs or feature requests through the web interface at
<http://rt.cpan.org>.
INSTALLATION
See perlmodinstall for information and options on installing Perl
modules.
AVAILABILITY
The latest version of this module is available from the Comprehensive
Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a
CPAN site near you. Or see <http://search.cpan.org/dist/Pod-Markdown/>.
The development version lives at
<http://github.com/hanekomu/pod-markdown/>. Instead of sending patches,
please fork this project using the standard git and github
infrastructure.
AUTHORS
Marcel Grünauer, "<marcel@cpan.org>"
Victor Moral, "<victor@taquiones.net>"
COPYRIGHT AND LICENSE
Copyright 2009 by Marcel Grünauer
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
SEE ALSO
This module is strongly based on "pod2mdwn" from Module::Build::IkiWiki.