HTML::F...arkdown(3)

🦋 HTML::FormatMarkdown(3) — bestie edition 🦋

okay so this is a page from the User Contributed Perl Documentation fam, and it's literally about turning HTML into Markdown. no cap, that's the whole vibe. 💅

---

✨ NAME ✨

HTML::FormatMarkdown — the formatter that takes your HTML and gives you Markdown back. it's giving glow-up but for markup. 🌸

---

🎀 VERSION 🎀

version 2.16

(that's the number, bestie, write it down 🫶)

---

💖 SYNOPSIS 💖

like, here's the whole thing in code, exactly as it is, don't @ me:

    use HTML::FormatMarkdown;

    my $string = HTML::FormatMarkdown->format_file(
        'test.html'
    );

    open my $fh, ">", "test.md" or die "$!\n";
    print $fh $string;
    close $fh;

so you use the module, you call format_file on 'test.html', you get a $string back, then you open a filehandle writing to "test.md" with or die "$!\n", print the string into it, and close it. iconic. that's the entire workflow and it ate. ⭐

---

🔥 DESCRIPTION 🔥

HTML::FormatMarkdown is a formatter that outputs Markdown. yes, that's it, that's the job description, and honestly? main character energy. 👑

here's the important part though — HTML::FormatMarkdown is built on HTML::Formatter, and the documentation for that module applies to this one too. especially "new" in HTML::Formatter, "format_file" in HTML::Formatter and "format_string" in HTML::Formatter. so if you're confused about how any of those work, go read HTML::Formatter, iykyk. 💜

---

🌈 AUTHORS 🌈

these are the legends who made it happen, show some respect:

• Nigel Metheringham <nigelm@cpan.org>
• Sean M Burke <sburke@cpan.org>
• Gisle Aas <gisle@ActiveState.com>

---

💀 COPYRIGHT AND LICENSE 💀

read this bit, bestie, it's the legal stuff and it's not optional 🙈

This software is copyright (c) 2016 by Nigel Metheringham, 2002-2005 Sean M Burke, 1999-2002 Gisle Aas.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. fr fr, go wild, but like, within the same terms. 🧚

---

and that's the page!! 💅 mwah, go format some HTML into Markdown, you absolute icon 🫶

sign-off szn: this was HTML::FormatMarkdown(3) from the perl v5.40.2 docs, dated 2023-07-03. slay. 🎀