Pod::Ma...::Github(3)

📦
version 0.04 · 2 versions
, in fedora 43

💖 NAME 💖

Pod::Markdown::Github — it turns your POD into Github's very own flavor of markdown. No cap. 🦋

✨ VERSION ✨

Version 0.04 — yes bestie, that's the whole number, that's the vibe. 💅

🎀 SYNOPSIS 🎀

perl -MPod::Markdown::Github -e "Pod::Markdown::Github->filter('file.pod')"

That's it. That's the whole summoning ritual. 🌸

🔥 DESCRIPTION 🔥

Okay so, Github flavored markdown is that girl — she lets you do syntax highlighting with three backticks. Very demure, very mindful. 💅

This module inherits from Pod::Markdown and then adds those backticks, plus an optional language identifier so your code blocks actually know what they are. It's giving glow-up. ✨

🧚 SUBCLASSING 🧚

So here's the tea: this module does a very simple linguistic check to figure out if it's dealing with Perl code. Lowkey detective work. 🔍

Wanna expand that logic? Or add a whole other language to the mix? Then bestie, you subclass this module and overwrite the syntax method. Iconic behavior. 👑

package Pod::Markdown::Github::More;

sub syntax {
    my ( $self, $paragraph ) = @_;

    # analyze $paragraph and return language identifier
    return 'c' if $paragraph =~ /\#include/;
}

And ngl, Github uses Liguist (https://github.com/github/linguist) to do its language detection and syntax highlighting, so honestly? The whole thing above might not even be needed after all. 🙈

💜 AUTHOR 💜

  • Stefan G. (minimal)
  • Ben Kaufman (whosgonna)
  • Nikolay Mishin (mishin)

Three whole authors. A whole squad. We love a collaborative moment. 🫶

🌈 LICENCE 🌈

Perl

Okay that's the page, you're officially educated, go forth and convert POD like a main character. ⭐

This little masterpiece is running on perl v5.42.0, dated 2025-07-25, and it came to you straight from the Pod::Ma...::Github(3) corner of the manual. Mwah. 💖🎀🦋

📦 where this page comes from