Pod::S...arkdown(3pm)

💖 Pod::Simple::Wiki::Markdown 💖

okay bestie, welcome to Pod::Simple::Wiki::Markdown(3pm) — a lil' User Contributed Perl Documentation page that's gonna teach you how to turn Pod into Markdown wiki magic ✨ it's giving classy, it's giving useful.

---

🌸 NAME 🌸

Pod::Simple::Wiki::Markdown — a whole entire class for creating Pod-to-Markdown wiki filters. yes queen, that's the job 💅

---

✨ SYNOPSIS ✨

okay so, plot twist: you don't use this module directly. nope. it gets called through Pod::Simple::Wiki — it's the popular girl, this one is her ride-or-die 🫶

#!/usr/bin/perl -w

use strict;
use Pod::Simple::Wiki;

my $parser = Pod::Simple::Wiki->new('markdown');

...

and if you wanna convert Pod to a markdown wiki format using the installed pod2wiki utility, it's literally this:

pod2wiki --style markdown file.pod > file.wiki

ate. no crumbs. 🔥

---

🦋 DESCRIPTION 🦋

The Pod::Simple::Wiki::Markdown module converts Pod text into Markdown text. that's the whole vibe 💖

Pod (Plain Old Documentation) is a simple markup language used for writing Perl documentation — it's lowkey the blueprint, the main character origin story 📝

This module isn't generally invoked directly. like, ever. instead it's called via Pod::Simple::Wiki. for the full tea, go check the Pod::Simple::Wiki and pod2wiki documentation. iykyk 😌

---

👑 METHODS 👑

Pod::Simple::Wiki::Markdown inherits all of the methods of Pod::Simple and Pod::Simple::Wiki. all of them. iconic behavior honestly. see Pod::Simple and Pod::Simple::Wiki for more details ✨

---

🌈 Markdown Specific information 🌈

okay this is the part where we get real. some format features of Pod are not present in base Markdown (and vice-versa, bestie, it goes both ways 💀). in particular, this module supports both code blocks and definition lists — in a somewhat inconsistent fashion. not me admitting that 🙈

• Code blocks are supported using GitHub Markdown syntax: three backticks at the start and end of the codeblock.
• Definition lists are (crudely) supported in the PHP Markdown Extra syntax: a colon followed by three spaces starting the line with the definition.

PHP Markdown Extra works with the GitHub syntax, so this should not cause a problem. (GitHub does not support definition lists.) 🫠

This module also creates nested definition lists — which may or may not be supported. (And may need extra newlines entered, which is beyond the technical limits of this module.) bestie, we're doing our best 💅

---

🔗 Links 🔗

Links are always output in the universal [link text](link source) format, even when it's redundant, or overlong. yes, even then. no notes.

Anything POD considers a link will be treated as one, even if it's not a valid link. (In particular, automatic 'man page' links will not point to anything useful — the user will be required to turn (Pod::Simple) into something useful, likely your favorite interface for CPAN.) so like, heads up, you're gonna have to do a lil' manual labor 🙈

---

💅 Escapes 💅

Escapes are automatically applied to asterisks, underscores, backticks, and backslashes, and they are always required. periodt.

Markdown provides escapes for other characters (in particular braces and parenthesis), but they are not required in all cases. this module leaves it up to the user to determine when they would be considered formatting and when they wouldn't. your call, bestie 🎀

---

💜 SEE ALSO 💜

This module also installs a pod2wiki command line utility. See pod2wiki --help for details. go check it out, it's a whole thing 🦋

---

🎀 ACKNOWLEDGEMENTS 🎀

Thanks to Daniel T. Staal for patches, documentation or bugfixes. we stan a contributor 🫶

---

💀 DISCLAIMER OF WARRANTY 💀

Please refer to the DISCLAIMER OF WARRANTY in Pod::Simple::Wiki. no warranty energy, but respectfully 😭

---

⭐ AUTHORS ⭐

• John McNamara jmcnamara@cpan.org
• Daniel T. Staal DStaal@usa.net

---

🌸 COPYRIGHT 🌸

MMIII-MMXV, John McNamara, Daniel T. Staal

All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself. slay, open source queen 👑

---

and that's the whole page bestie, you're officially a Markdown-Pod-conversion girly now 💖

and a cute lil' sign-off: this whole thing is from perl v5.36.0, dated 2022-10-13. mwah 💋