Pod::Markdown::Github - Convert POD to Github's specific markdown
Version 0.04
perl -MPod::Markdown::Github -e "Pod::Markdown::Github->filter('file.pod')"
Github flavored markdown allows for syntax highlighting using three backticks.
This module inherits from Pod::Markdown and adds those backticks and an optional language identifier.
This module performs a very simple linguistic check to identify if it's dealing with Perl code. To expand on this logic, or to add other languages one may subclass this module and overwrite the syntax method.
syntax
package Pod::Markdown::Github::More; sub syntax { my ( $self, $paragraph ) = @_; # analyze $paragraph and return language identifier return 'c' if $paragraph =~ /\#include/; }
Github uses Liguist to perform language detection and syntax highlighting, so the above may not be needed after all.
Stefan G. (minimal)
Ben Kaufman (whosgonna)
Nikolay Mishin (mishin)
Perl
To install Pod::Markdown::Github, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::Markdown::Github
CPAN shell
perl -MCPAN -e shell install Pod::Markdown::Github
For more information on module installation, please visit the detailed CPAN module installation guide.