.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Markdent::Dialect::GitHub 3pm"
.TH Markdent::Dialect::GitHub 3pm "2019-01-26" "perl v5.28.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Markdent::Dialect::GitHub \- Markdown extensions implemented on GitHub
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Markdent::Parser;
\&
\& my $parser = Markdent::Parser\->new( dialect => \*(AqGitHub\*(Aq, handler => ... );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The GitHub roles add parsing for some of the Markdown extensions used on
GitHub. See for details.
.SS "\s-1DEVIATIONS\s0"
.IX Subsection "DEVIATIONS"
The dialect differs from the GitHub implementation in a few ways.
.IP "\(bu" 4
It doesn't yet implement the newline handling that GitHub specifies.
.IP "\(bu" 4
It does not implement the GitHub specific auto-linking for SHAs, users, or
projects. This is intentional.
.SS "\s-1IMPLEMENTATION DETAILS\s0"
.IX Subsection "IMPLEMENTATION DETAILS"
When the start of a fenced code block includes a language indicator
(\f(CW\*(C`\`\`\`perl\*(C'\fR), the \s-1HTML\s0 output will include that language as part of a class
name on the \f(CW\*(C`\*(C'\fR tag:
.PP
.Vb 1
\& ...
.Ve
.SH "BUGS"
.IX Header "BUGS"
See Markdent for bug reporting details.
.SH "AUTHOR"
.IX Header "AUTHOR"
Dave Rolsky,
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2012 Dave Rolsky, All Rights Reserved.
.PP
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.