Pod::Github - convert POD to Github markdown
my $parser = Pod::Github->new(%opts); $parser->output_fh(\*STDOUT); $parser->parse_file(\*ARGV);
Subclass of Pod::Simple that accepts POD and outputs Github Flavored Markdown (GFM). Optionally inlines or removes headings and/or prettifies the markdown to look better as a GitHub readme.
Pod::Simple
Accepts the arguments in the same form as the binary bin/pod2github (i.e. with dashes, not underscores). include, exclude and inline should be arrayrefs of section names rather than a CSV string.
bin/pod2github
include
exclude
inline
Set the filehandle for Markdown output.
Sets the string that $parser's output will be sent to, instead of a filehandle.
Read POD from the given filehandle and output Markdown to output_fh.
output_fh
Works like parse_file except it reads the POD from a string already in memory.
parse_file
Works like parse_file except it reads the POD from a list of strings, each containing exactly one line of content.
To install Pod::Github, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::Github
CPAN shell
perl -MCPAN -e shell install Pod::Github
For more information on module installation, please visit the detailed CPAN module installation guide.