Markde...cument(3pm)

✨ NAME ✨

Markdent::Simple::Document — okay bestie, this is the 3pm manual page (User Contributed Perl Documentation, iykyk), and it does exactly one iconic thing: Convert Markdown to an HTML Document. 💅

---

🎀 VERSION 🎀

version 0.40 — yes she's got a version number, she's official. ✨

---

🦋 SYNOPSIS 🦋

Look at her, so simple, so clean:

use Markdent::Simple::Document;

my $mds  = Markdent::Simple::Document->new;
my $html = $mds->markdown_to_html(
    title    => 'My Document',
    markdown => $markdown,
);

That's it. That's the whole vibe. 😭

---

🌸 DESCRIPTION 🌸

This class gives you a very simple interface for converting Markdown into a complete HTML document. No drama, no fuss, just markdown in, whole-ass HTML document out. Periodt. 💖

---

👑 METHODS 👑

She comes with the following methods, bestie:

Markdent::Simple::Document->new

Creates a brand new Markdent::Simple::Document object. Fresh out the box, main character energy. ✨

$mds->markdown_to_html( title => $title, markdown => $markdown )

This method turns Markdown into HTML. It accepts the following parameters:

• title => $title — The title of the document. This is required, so do not skip her, fr fr. 🫶
• charset => $charset — If provided, a <meta charset="..."> tag will be added to the document's <head>. Cute little charset glow-up. 🎀
• language => $language — If provided, a lang attribute will be added to the document's <html> tag. Accessibility ate, no cap. 💅
• dialects => [...] — This can either be a single string or an array ref of strings containing the class names of dialects. This parameter is optional, so it's giving chill. 🌈

---

🧚 ROLES 🧚

This class does the Markdent::Role::Simple role. She's committed, she's loyal, she's got roles. 💜

---

💀 BUGS 💀

See Markdent for bug reporting details.

Bugs may be submitted at <https://github.com/houseabsolute/Markdent/issues>.

I am also usually active on IRC as 'autarch' on irc://irc.perl.org.

Bestie if you find a bug, don't be shy — report it, don't let it rot. 🙈

---

🔥 SOURCE 🔥

The source code repository for Markdent can be found at <https://github.com/houseabsolute/Markdent>.

Go peek, go star it, go be nosy. ⭐

---

⭐ AUTHOR ⭐

Dave Rolsky <autarch@urth.org>

Legend behaviour honestly. 👑

---

🌈 COPYRIGHT AND LICENSE 🌈

This software is copyright (c) 2021 by Dave Rolsky.

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

The full text of the license can be found in the LICENSE file included with this distribution.

---

Okay that's the whole page, mwah 💖 — this was Markdent::Simple::Document, 3pm, running on perl v5.32.1, dated 2021-08-31. Go forth and convert that Markdown, bestie. 🦋✨