1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
package Pithub::Markdown;
our $AUTHORITY = 'cpan:PLU';
our $VERSION = '0.01043';
# ABSTRACT: Github v3 Markdown API
use Moo;
use Carp qw( croak );
extends 'Pithub::Base';
has [qw( mode context )] => ( is => 'rw' );
sub render {
my ( $self, %args ) = @_;
croak 'Missing key in parameters: data (hashref)'
unless defined $args{data};
for (qw( context mode )) {
$args{data}{$_} = $self->$_ if !exists $args{data}{$_} and $self->$_;
}
return $self->request(
method => 'POST',
path => '/markdown',
%args,
);
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Pithub::Markdown - Github v3 Markdown API
=head1 VERSION
version 0.01043
=head1 ATTRIBUTES
=head2 mode
The rendering mode. Can be either:
=over
=item *
C<markdown> to render a document in plain Markdown, just like README.md
files are rendered.
=item *
C<gfm> to render a document in GitHub Flavored Markdown, which creates
links for user mentions as well as references to SHA-1 hashes, issues,
and pull requests.
=back
=head2 context
The repository context to use when creating references in C<gfm> mode.
Omit this parameter when using C<markdown> mode.
=head1 METHODS
=head2 render
Render an arbitrary Markdown document
POST /markdown
Example:
use Pithub::Markdown;
my $response = Pithub::Markdown->new->render(
data => {
text => "Hello world github/linguist#1 **cool**, and #1!",
context => "github/gollum",
mode => "gfm",
},
);
# Note that response is NOT in JSON, so ->content will die
my $html = $response->raw_content;
=head1 AUTHOR
Johannes Plunien <plu@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2011 by Johannes Plunien.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|
