-
-
25 Jan 2019 05:52:03 UTC
- Distribution: Pod-Markdown-Github
- Module version: 0.04
- Source (raw)
- Browse (raw)
- Changes
- How to Contribute
- Repository
- Issues
- Testers (4247 / 7 / 0)
- Kwalitee
Bus factor: 0- 96.00% Coverage
- License: perl_5
- Perl: v5.8.0
- Activity
24 month- Tools
- Download (13.15KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
NAME
Pod::Markdown::Github - Convert POD to Github's specific markdown
VERSION
Version 0.04
SYNOPSIS
perl -MPod::Markdown::Github -e "Pod::Markdown::Github->filter('file.pod')"
DESCRIPTION
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.
SUBCLASSING
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.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.
AUTHOR
Stefan G. (minimal)
Ben Kaufman (whosgonna)
Nikolay Mishin (mishin)
LICENCE
Perl
Module Install Instructions
To install Pod::Markdown::Github, copy and paste the appropriate command in to your terminal.
cpanm Pod::Markdown::Github
perl -MCPAN -e shell install Pod::Markdown::Github
For more information on module installation, please visit the detailed CPAN module installation guide.