POD2GITHUB(1)

📦
version 0.04 · 3 versions
, in fedora 43

💖 POD2GITHUB — the manual, but make it cute 💖

okay bestie, gather round, because this is the little Perl script that turns your boring POD into Github-flavored markdown and honestly? it's giving ✨main character energy✨. it's pod2github, it lives in the User Contributed Perl Documentation section of your man pages, and it's here to make your docs slay.

🌸 NAME 🌸

pod2github — convert POD text to Github flavored markdown 🎀

🦋 VERSION 🦋

version 1.000 — yes she's vintage, yes she still eats 💅

✨ SYNOPSIS ✨

four ways to run her, pick your fighter:

# parse STDIN, print to STDOUT
$ pod2github < POD_File > Markdown_File

# parse file, print to STDOUT
$ pod2github input.pod

# parse file, print to file
$ pod2github input.pod output.mkdn

# parse STDIN, print to file
$ pod2github - output.mkdn

💜 DESCRIPTION 💜

so what's the vibe? this program uses Pod::Markdown::Github to convert POD into Github Markdown sources. that's the whole plot. no cap. 🔥

UTF-8 is the default output encoding if you don't specify any encoding options (peep "OPTIONS" below, bestie, that's where the encoding drama lives 👀).

she accepts two optional arguments:

  • input pod file — defaults to STDIN
  • output markdown file — defaults to STDOUT

that's it. that's the whole interface. iconic minimalism fr fr 🫶

👑 OPTIONS 👑

  • --html-encode-chars — a list of characters to encode as HTML entities. pass a regexp character class, or pass 1 to mean control chars, high-bit chars, and "<&>"'". if you wanna know more, go read "html_encode_chars" in Pod::Markdown. 🧚
  • --match-encoding, -m — use the same =encoding as the input pod for the output file. matchy-matchy, we love a coordinated fit 💖
  • --output-encoding, -e — specify the encoding for the output file. you're the boss, you pick 🌈
  • --utf8, -u — alias for -e UTF-8. short, sweet, slays 💅

🌈 SEE ALSO 🌈

ngl, this program is pretty much a straight copy of pod2markdown, which is in turn strongly based on "pod2mdwn" from Module::Build::IkiWiki. family tree ate. 🌳✨

⭐ AUTHOR ⭐

Stefan G. <minimal@cpan.org> — thank you for your service, king 👑

💀 CREDITS 💀

this software is based on work by:

  • Marcel Gruenauer <marcel@cpan.org>
  • Victor Moral <victor@taquiones.net>
  • Ryan C. Thompson <rct at thompsonclan d0t org>
  • Aristotle Pagaltzis <pagaltzis@gmx.de>
  • Randy Stauner <rwstauner@cpan.org>

legends, all of them, no notes 🫶

this is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. so go forth and remix, bestie 💖

ok that's the whole page, thanks for coming to my ted talk 💅

and for the record? this whole thing came from perl v5.42.0 on 2025-07-25, and it's filed under POD2GITHUB(1). mwah 💋 bye bestie!! 🌸✨

📦 where this page comes from