1Pod::Markdown::Github(3U)ser Contributed Perl DocumentatiPoond::Markdown::Github(3)
2
3
4

NAME

6       Pod::Markdown::Github - Convert POD to Github's specific markdown
7

VERSION

9       Version 0.04
10

SYNOPSIS

12           perl -MPod::Markdown::Github -e "Pod::Markdown::Github->filter('file.pod')"
13

DESCRIPTION

15       Github flavored markdown allows for syntax highlighting using three
16       backticks.
17
18       This module inherits from Pod::Markdown and adds those backticks and an
19       optional language identifier.
20

SUBCLASSING

22       This module performs a very simple linguistic check to identify if it's
23       dealing with Perl code. To expand on this logic, or to add other
24       languages one may subclass this module and overwrite the "syntax"
25       method.
26
27           package Pod::Markdown::Github::More;
28
29           sub syntax {
30               my ( $self, $paragraph ) = @_;
31
32               # analyze $paragraph and return language identifier
33               return 'c' if $paragraph =~ /\#include/;
34           }
35
36       Github uses Liguist <https://github.com/github/linguist> to perform
37       language detection and syntax highlighting, so the above may not be
38       needed after all.
39

AUTHOR

41       Stefan G. (minimal)
42
43       Ben Kaufman (whosgonna)
44
45       Nikolay Mishin (mishin)
46

LICENCE

48       Perl
49
50
51
52perl v5.34.0                      2022-01-21          Pod::Markdown::Github(3)