HTML::...arkdown(3pm)

🦋 HTML::WikiConverter::Markdown — the manual, but make it cute

okay bestie, so this page is literally HTML::...arkdown(3pm), and it lives in the User Contributed Perl Documentation section. yes that's a mouthful, we move 💅

---

✨ NAME ✨

HTML::WikiConverter::Markdown — convert HTML to Markdown markup. that's it, that's the whole job 🎀

---

🌸 SYNOPSIS 🌸

use HTML::WikiConverter;
my $wc = new HTML::WikiConverter( dialect => 'Markdown' );
print $wc->html2wiki( $html );

look at her go. three lines and she's converting. iconic ✨

---

💖 DESCRIPTION 💖

so this module is the rulebook — it's holding all the rules for turning HTML into Markdown markup.

but bestie, do not use this module directly, i am begging 🙈

HTML::WikiConverter is the actual entry point for html->wiki conversion (peep the synopsis above, it's right there). if you want the full usage deets, go read HTML::WikiConverter. this one is just the vibe, the other one is the doer 💜

---

👑 ATTRIBUTES 👑

besides the regular set of attributes that the HTML::WikiConverter constructor already recognizes, this dialect also accepts the following extra attributes that you can pass into the new() constructor. for usage details, check "ATTRIBUTES" in HTML::WikiConverter.

🎀 header_style

possible values: 'setext', 'atx'. this one decides how headers "h1"-"h6" get formatted. more info here: http://daringfireball.net/projects/markdown/syntax#header. default is 'atx'.

🎀 link_style

possible values: 'inline', 'reference'. more info: http://daringfireball.net/projects/markdown/syntax#link. default is 'reference'.

🎀 force_inline_anchor_links

possible values: 0, 1. if you enable this, links to anchors within the same page (like "#some-anchor") will always produce inline Markdown links — even when you're in reference link style. lowkey useful for building tables of contents 👀 default is 0.

🎀 image_style

possible values: 'inline', 'reference'. more info: http://daringfireball.net/projects/markdown/syntax#img. default is 'reference'.

🎀 image_tag_fallback

possible values: 0, 1. so here's the tea: Markdown's image markup does not support image dimensions, periodt 😭 if "image_tag_fallback" is enabled, then image tags that contain dimensional information (ie, width or height) will not be converted into Markdown markup. instead, they get roughly preserved in their HTML form. default is 1.

🎀 unordered_list_style

possible values: 'asterisk', 'plus', 'dash'. more info: http://daringfireball.net/projects/markdown/syntax#list. default is 'asterisk'.

🎀 ordered_list_style

possible values: 'sequential', 'one-dot'. Markdown supports two different markups for ordered lists, and you get to pick your fighter:

• sequential style gives each list element its own ordinal number (ie, '1.', '2.', '3.', etc.)
• one-dot style gives each list element the same ordinal number (ie, '1.')

more info: http://daringfireball.net/projects/markdown/syntax#list. default is 'sequential'.

🎀 md_extra

possible values: 0, 1. this one supports the MarkDown Extra https://github.com/jmcmanus/pagedown-extra extensions. default is 0.

heads up bestie: this support is incomplete. 💀

# Tables                            Supported
# Fenced Code Blocks
# Definition Lists          Supported
# Footnotes
# Special Attributes
# SmartyPants
# Newlines
# Strikethrough

---

🫶 AUTHOR 🫶

David J. Iberri, "<diberri at cpan.org>" — thank you for your service king 👑

---

💀 BUGS 💀

please report any bugs or feature requests to "bug-html-wikiconverter-markdown at rt.cpan.org", or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=HTML-WikiConverter-Markdown.

here's the cute part: I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. we're in this together fr fr 🌈

---

🌸 SUPPORT 🌸

you can find documentation for this module with the perldoc command:

perldoc HTML::WikiConverter::Markdown

you can also look for information at:

• AnnoCPAN: Annotated CPAN documentation

http://annocpan.org/dist/HTML-WikiConverter-Markdown

• CPAN Ratings

http://cpanratings.perl.org/d/HTML-WikiConverter-Markdown

• RT: CPAN's request tracker

http://rt.cpan.org/NoAuth/Bugs.html?Dist=HTML-WikiConverter-Markdown

• Search CPAN

http://search.cpan.org/dist/HTML-WikiConverter-Markdown

---

💜 COPYRIGHT & LICENSE 💜

Copyright 2006 David J. Iberri, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

---

and that's the whole page, bestie — no cap ✨

this was brought to you by perl v5.36.0, dated 2022-12-13, and the one and only HTML::...arkdown(3pm). stay slay, go convert some html 💖