File: GitHub.pod

package info (click to toggle)
libmarkdent-perl 0.40-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,372 kB
  • sloc: perl: 5,225; sh: 24; makefile: 13
file content (60 lines) | stat: -rw-r--r-- 1,278 bytes parent folder | download | duplicates (2)
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
package Markdent::Dialect::GitHub;

=pod

=head1 NAME

Markdent::Dialect::GitHub - Markdown extensions implemented on GitHub

=head1 SYNOPSIS

  use Markdent::Parser;

  my $parser = Markdent::Parser->new( dialect => 'GitHub', handler => ... );

=head1 DESCRIPTION

The GitHub roles add parsing for some of the Markdown extensions used on
GitHub. See L<http://github.github.com/github-flavored-markdown/> for details.

=head2 DEVIATIONS

The dialect differs from the GitHub implementation in a few ways.

=over 4

=item

It doesn't yet implement the newline handling that GitHub specifies.

=item

It does not implement the GitHub specific auto-linking for SHAs, users, or
projects. This is intentional.

=back

=head2 IMPLEMENTATION DETAILS

When the start of a fenced code block includes a language indicator
(C<```perl>), the HTML output will include that language as part of a class
name on the C<< <code> >> tag:

  <pre><code class="language-perl">...</code></pre>

=head1 BUGS

See L<Markdent> for bug reporting details.

=head1 AUTHOR

Dave Rolsky, E<lt>autarch@urth.orgE<gt>

=head1 COPYRIGHT & LICENSE

Copyright 2012 Dave Rolsky, All Rights Reserved.

This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.

=cut