Scroll to navigation

Markdent::Dialect::GitHub(3pm) User Contributed Perl Documentation Markdent::Dialect::GitHub(3pm)

NAME

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

SYNOPSIS

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

DESCRIPTION

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

DEVIATIONS

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

  • It doesn't yet implement the newline handling that GitHub specifies.
  • It does not implement the GitHub specific auto-linking for SHAs, users, or projects. This is intentional.

IMPLEMENTATION DETAILS

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

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

BUGS

See Markdent for bug reporting details.

AUTHOR

Dave Rolsky, <autarch@urth.org>

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.

2021-08-31 perl v5.32.1