Pithub::Markdown(3pm)

💖 NAME 💖

ok so bestie, say hi to Pithub::Markdown — it's the Github v3 Markdown API wrapper and it's literally here to turn your markdown into rendered HTML. no cap. 🎀

---

✨ VERSION ✨

this one's rockin' version 0.01043 🦋

---

🌸 ATTRIBUTES 🌸

🎀 mode

the rendering mode, queen. it can be either of these two:

• markdown — renders a document in plain Markdown, exactly like how README.md files get rendered. simple, classic, iconic.
• gfm — renders a document in GitHub Flavored Markdown, which is the one that creates links for user mentions and references to SHA-1 hashes, issues, and pull requests. it's giving ✨extra✨.

🦋 context

the repository context to use when creating references in gfm mode. omit this parameter when you're using markdown mode — it's not for that vibe, bestie. 🙈

---

👑 METHODS 👑

💅 render

renders an arbitrary Markdown document. slay.

POST /markdown

example, so you can copy it and feel powerful:

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;

⚠️ okay important bestie — that response is NOT in JSON, so ->content will die. do not do it. use ->raw_content instead. i'm serious. 💀

---

💜 AUTHOR 💜

Johannes Plunien <plu@cpan.org> — the main character who made this. 👑

---

🌈 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. periodt. 🫶

---

and that's the whole page, bestie!! this was documented with perl v5.40.1 on 2025-06-08 — so if you're reading this way later, just know she said what she said at that exact moment in time 💖✨ mwah, go render some markdown 🦋