Markde...:GitHub(3pm)

πŸ“¦
version 0.40 Β· 2 versions
, in debian bookworm, ubuntu jammy, ubuntu noble

🌸 NAME 🌸

Markdent::Dialect::GitHub β€” bestie, it's the Markdown extensions that GitHub implemented, wrapped up all cute in a Perl module πŸ’–

It lives in the 3pm section of the manual, iykyk.


✨ SYNOPSIS ✨

okay so here's the whole vibe, literally just this:

use Markdent::Parser;

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

That's it. That's the whole thing. Slay. πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

So the GitHub roles (they're called roles, don't ask) add parsing for some of the Markdown extensions used on GitHub. If you wanna read the actual details from the source of truth, it's over at http://github.github.com/github-flavored-markdown/ β€” go look, no cap 🌈

πŸŽ€ DEVIATIONS πŸŽ€

ngl, this dialect is not a perfect clone of what GitHub does. It differs in a few ways, and we're gonna be honest about them:

  • It doesn't yet implement the newline handling that GitHub specifies. 😭 (yet! the "yet" is doing a lot of work here)
  • It does not implement the GitHub specific auto-linking for SHAs, users, or projects. And listen β€” this is intentional. Not a bug. On purpose. Periodt. πŸ’€

🧚 IMPLEMENTATION DETAILS 🧚

okay this part is kinda iconic actually. When the start of a fenced code block includes a language indicator (like ```perl), the HTML output will include that language as part of a class name on the <code> tag, like so:

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

the way it just knows the language and slaps it in the class... obsessed 🫢


πŸ’€ BUGS πŸ’€

See Markdent for bug reporting details. That's the move, bestie, go there πŸ‘‘


πŸ‘‘ AUTHOR πŸ‘‘

Dave Rolsky, <autarch@urth.org> β€” legend behavior, fr fr 🌟


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.


and that's the whole page, bestie ✨ this was perl v5.32.1, dated 2021-08-31, from Markde...:GitHub(3pm) β€” mwah, go parse something cute πŸ’–πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from