PMARKDOWN(1p)

💖 PMARKDOWN 💖

okay bestie, so this is pmarkdown — that's the manpage name, section 1p, it's a Perl thing, don't worry about it — and honestly? she's THAT girl. A very configurable Markdown processor written in pure Perl, supporting the CommonMark spec AND a whole bunch of extensions. no cap. 🎀

---

✨ NAME ✨

pmarkdown — a very configurable Markdown processor written in pure Perl, supporting the CommonMark spec and many extensions. she's flexible, she's pure Perl, she contains multitudes 💅

---

🌸 SYNOPSIS 🌸

pmarkdown [-o key=value] ... < in_file.md > out_file.html_fragment

like yes, she reads from stdin and writes to stdout, it's giving classic Unix baddie 🦋

---

💜 DESCRIPTION 💜

okay so here's the tea: currently pmarkdown can only read a single input from its standard input, and she writes her output on the standard output. both of those are assumed to be encoded in UTF-8, periodt. ✨

if you need it, go see the GitHub pmarkdown page <https://github.com/mkende/pmarkdown> for installation instructions. it's all there bestie, i promise 🫶

---

👑 OPTIONS 👑

• --help, -h — shows a short help message about the program. the lil appetizer 🍓
• --helpfull — shows the complete man page of the program. yes it's spelled --helpfull with two L's, that's not a typo, that's just her vibe 😌
• --list-options — shows the documentation of ALL the existing options of the Markdown processor. this is the exact same content that lives on the Markdown::Perl::Options page. and psst — these options can be passed to the program with the --options flag 👀
• --version, -v — shows the version of this program. the humble brag ✨
• --mode mode, -m — specifies a mode for the Markdown processor. a mode is basically a set of configuration options that work together, typically to replicate the semantics of another existing Markdown processor. see the MODES section in this page for the list of available modes 📋

when a mode is applied, it sets specific values for some options — but any value for those options set through the --option flag will take precedence. she respects your choices, fr fr 💅

• --option option=value, -o — specifies the value for one particular option. the --option flag can be passed multiple times. if an option is specified multiple times, the last value takes precedence. last one wins, no take-backs 🏁

the options are described in the Markdown::Perl::Options page. you can see it with the pmarkdown --list-options command. go look, it's a whole mood ✨

when specifying an option value, boolean options should be passed as either 0, 1, "false", or "true". those are the only four fits she'll accept 💀

note that ALL options are applied on top of the selected mode. even if the options are passed before the --mode flag, the mode will not override options set through --option. she said what she said 💅

---

🌈 MODES 🌈

• default — the default mode if no other mode is specified. this mode uses the default value for all the options (as per their documentation). the default syntax is documented in the GitHub repository of the project: <https://github.com/mkende/pmarkdown/blob/main/Syntax.md>

note that, in practice, setting the mode to default is equivalent to not setting a mode at all — except that subsequent calls to set a mode will raise a warning about the mode being overwritten. so like, she'll be a lil petty about it 🙈

• cmark — this mode implements the full CommonMark spec <https://spec.commonmark.org/0.31.2/>. the whole thing. full send 🔥
• github — this mode implements the GitHub Flavored Markdown <https://github.github.com/gfm/> variant of the CommonMark spec. github girlies rise 🫶
• markdown — this mode implements the original Markdown syntax <https://daringfireball.net/projects/markdown/syntax>. the O.G., the blueprint, the icon 🌟

note that this mode is not 100% similar to the original Markdown.pl script, because that script has some buggy behavior that we are not reproducing. we said what we said 💀

---

🎀 AUTHOR 🎀

this program has been written by Mathias Kende <mailto:mathias@cpan.org>. absolute legend, we stan 👑

---

🦋 LICENCE 🦋

Copyright 2024 Mathias Kende

this program is distributed under the MIT (X11) License: <http://www.opensource.org/licenses/mit-license.php>

and here's the full legal text, verbatim, because bestie we do NOT paraphrase legal documents 💖

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---

🌟 SEE ALSO 🌟

• cmark(1)
• CommonMark Spec <https://spec.commonmark.org/0.30/#links>

iykyk 💜

---

and that's the whole page bestie!! 🎉 this one came from perl v5.40.1 and it's dated 2025-04-25 — so like, go forth, pipe your markdown through her, and slay ✨💅🌈