MARKDENT-HTML(1p)

✨ markdent-html(1p) ✨

okay so bestie, you're holding the manual page for markdent-html, a lil command-line baddie from the Markdent crew that turns your Markdown into HTML. she's giving "user contributed perl documentation" and honestly? she ate. 💅

---

🌸 VERSION 🌸

version 0.40 — yes queen, that's the one we're on. ✨

---

🎀 SYNOPSIS 🎀

like, the whole vibe in one line:

$> markdent-html --file ./path/to/text.md

periodt. that's it. that's the tweet. 🦋

---

💖 DESCRIPTION 💖

This tool turns Markdown into HTML using Markdent. no cap, that's literally the entire job description and she does it flawlessly. 🌈

---

👑 OPTIONS 👑

she accepts the following command line options, and you're gonna want to know every single one of them, so let's go:

🍓 --file

The file containing the Markdown to process. You must provide this or --text, but not both. (pick a lane, bestie 😭)

Pass - to read from STDIN. yes, a single lil dash. iconic behavior.

🧚 --text

The Markdown text to process. You must provide this or --file, but not both.

🦋 --title

If you pass this then the output will be a full HTML document containing this as the <title> tag. If this isn't passed then the output will be an HTML fragment with no <html> or <body> tags.

so basically: no --title, no full doc. just the fragment. lowkey minimal of her, highkey valid. 💅

🌸 --charset

If you pass this with a --title it will be used to populate a <meta charset="..."> tag for the document.

(notice how she said with a --title? yeah, she needs the title first. the charset is the plus-one. 🫶)

💜 --language

If you pass this with a --title it will be used to set the lang attribute for the document's <html> tag.

again — it's a package deal with --title. they're a duo. main character energy only when the title shows up. ✨

⭐ --dialects

You can add one or more dialects to the standard parser with this option. This can either be a full class name like Markdent::Dialect::GitHub or just a short name like GitHub.

so like, Markdent::Dialect::GitHub if you're feeling formal, or just GitHub if you're texting her from bed. both work. 🎀

---

🔥 SUPPORT 🔥

Bugs may be submitted at https://github.com/houseabsolute/Markdent/issues. (tell her what's wrong, she can take it 💀)

I am also usually active on IRC as 'autarch' on irc://irc.perl.org. come say hi, fr fr.

---

🌈 SOURCE 🌈

The source code repository for Markdent can be found at https://github.com/houseabsolute/Markdent. go snoop, you know you want to. 👑

---

💅 AUTHOR 💅

Dave Rolsky <autarch@urth.org> — the legend herself. 🫶

---

🎀 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 bestie, real talk: it's free software, the same terms as Perl 5 itself, and if you want the whole legal essay it's sitting right there in the LICENSE file. read it, love it, respect it. 💖

---

and that's the page!! 🦋 written by us, perl v5.32.1, dated 2021-08-31 — go forth and convert some Markdown, you absolute icon. mwah. 💋✨