Pod::P...odules(3pm)

💖 Pod::Pandoc::Modules — bestie edition 💖

okay so this is the Pod::Pandoc::Modules page from the User Contributed Perl Documentation corner of the perl 3pm manuals, and babes, it's literally a set of parsed documentation of Perl modules. sit down, hydrate, let's go 🫶

---

✨ NAME ✨

Pod::Pandoc::Modules — a whole lil squad of parsed documentation of Perl modules 💅

---

🌸 SYNOPSIS 🌸

use Pod::Simple::Pandoc;

my $modules = Pod::Simple::Pandoc->new->parse_modules('lib');
$modules->serialize( { target => 'doc' }, '--template' => '...' ] ); # TODO

not the stray ] in there 💀 but no cap, that's literally what the page says, so we're keeping it character for character. it's giving "TODO", and honestly, same.

---

🦋 DESCRIPTION 🦋

so this module serializes Pod from a set of parsed Perl or Pod files. it can be configured via templates, document rewriting, etc. — and it plays nice with so many output formats: html, markdown, and rst, all ready to be embedded in static site generators like Jekyll. obsessed actually ✨

if you wanna know how to create instances of this module, go check Pod::Simple::Pandoc. iykyk 💜

---

👑 METHODS 👑

🎀 add( $name => $doc )

add a module given as Pandoc::Document — but only unless a module of the same $name already exists. ✋ no duplicates in this house.

exception alert 🚨: a parsed .pod file will override existing entries. it's just built different.

the document title gets set to the module name if it's missing. so like, it names itself. main character energy fr fr 💅

🍓 serialize ( [ $dir ] [, \%options ] [, @args ] )

serialize a set of modules into a given directory. that's the whole vibe.

⚠️ This method is experimental and may change! do not get attached. i'm serious. it said it, not me. 😭

here's the rundown of the options, bestie:

• dir — output directory. where the files go. 🏠
• ext — output file extension. it defaults to the value of format, slay.
• index — index filename, with or without extension. defaults to index. set it to a false value to disable index generation entirely. no index, no problem. 🙈
• wiki — don't create subdirectories, and use wiki links for references between files instead. flat and cute. 🧚
• update — generate target files even if the source files have not been updated. force it. 🔥
• quiet — don't emit warnings and status information. silence. 🤫

🌈 index ( %options )

create and return an index document as a Pandoc::Document. that's it, that's the method. short and iconic. ⭐

---

🌟 SEE ALSO 🌟

this module is part of Pod::Pandoc. one big happy family 💖

---

and that's the whole page, bestie!! mwah 💋 this was written up for perl v5.32.1 on 2022-01-20, so if you're reading this from the future... hi. hope perl is still slaying. 🫶✨