Pod::Markdown - Convert POD to Markdown
version 1.401
my $parser = Pod::Markdown->new; $parser->parse_from_filehandle(\*STDIN); print $parser->as_markdown;
This module subclasses Pod::Parser and converts POD to Markdown.
Literal characters in Pod that are special in Markdown (like *asterisks*) are backslash-escaped when appropriate.
Returns the url prefix in use (after resolving shortcuts to urls).
Returns the url prefix in use for man pages.
The constructor accepts the following named arguments:
perldoc_url_prefix
This alters the perldoc urls that are created from L<> codes. Can be:
L<>
metacpan (shortcut for https://metacpan.org/pod/)
metacpan
https://metacpan.org/pod/
sco (shortcut for http://search.cpan.org/perldoc?)
sco
http://search.cpan.org/perldoc?
any url
The default is metacpan.
Pod::Markdown->new(perldoc_url_prefix => 'http://localhost/perl/pod');
man_url_prefix
This alters the man page urls that are created from L<> codes.
The default is http://man.he.net/man.
http://man.he.net/man
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.
with_meta
pod2markdown - script included for command line usage
You can find documentation for this module with the perldoc command.
perldoc Pod::Markdown
The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.
MetaCPAN
A modern, open-source CPAN search engine, useful to view POD in HTML format.
http://metacpan.org/release/Pod-Markdown
Please report any bugs or feature requests by email to bug-pod-markdown at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Pod-Markdown. You will be automatically notified of any progress on the request by the system.
bug-pod-markdown at rt.cpan.org
https://github.com/rwstauner/Pod-Markdown
git clone https://github.com/rwstauner/Pod-Markdown.git
Marcel Gruenauer <marcel@cpan.org>
Victor Moral <victor@taquiones.net>
Ryan C. Thompson <rct at thompsonclan d0t org>
Aristotle Pagaltzis <pagaltzis@gmx.de>
Randy Stauner <rwstauner@cpan.org>
Aristotle Pagaltzis <aristotle@cpan.org>
Graham Ollis <plicease@cpan.org>
Peter Vereshagin <veresc@cpan.org>
Ryan C. Thompson <rthompson@cpan.org>
Yasutaka ATARASHI <yakex@cpan.org>
motemen <motemen@cpan.org>
moznion <moznion@cpan.org>
This software is copyright (c) 2004 by Marcel Gruenauer.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Pod::Markdown, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::Markdown
CPAN shell
perl -MCPAN -e shell install Pod::Markdown
For more information on module installation, please visit the detailed CPAN module installation guide.