MARKED-MAN(1)

💖 NAME 💖

marked-man — it's giving markdown to roff, bestie ✨

---

🌸 SYNOPSIS 🌸

marked-man README.md > doc/foo.1
# works too with stdin
cat README.md | marked-man --version 1.0 | man /dev/stdin

Also lowkey check out the marked documentation, fr fr 📚

---

✨ DESCRIPTION ✨

So marked-man wraps marked and extends it with groff output support, and the whole point of that glow-up is so you can create Unix manual pages for use with man. Iconic, honestly. 💅

It follows the ronn markdown level-1 header format:

# name(section) -- short description

and that line right there populates the HEADER section, plus the NAME section too (but only if you haven't already written one yourself, no cap). 👑

---

🎀 OPTIONS 🎀

marked-man is a marked CLI extension, meaning options can be passed directly to marked. Bestie, you have full access, go wild 🦋

The --breaks option — the one that retains intra-paragraph line breaks — is now true by default. So if you want it off, use --no-breaks to disable it. Periodt.

marked-man also adds some options on top of marked's existing options, so you can override the header/footer of your generated man pages. Very main character of it, honestly.

• --name <name> — Optional! Overrides the name in the ronn header. 💜
• --section <section> — Optional! Overrides the section in the ronn header. Defaults to 1.
• --description <description> — Optional! Overrides the description in the ronn header.
• --version <version> — The version shown in the manpage footer. Optional — when you omit it, it defaults to the target node module version, or empty. 🙈
• --manual <manual> — The manual-group name shown in the manpage header. Optional — when you omit it, man displays a value matching the section.
• --date <date> — The date shown in the manpage header. Optional, and it defaults to now. ✨ Must be acceptable to new Date(string or timestamp). It also honors the SOURCE_DATE_EPOCH environment variable for reproducible builds. Reproducibility? We love her. 🫶

---

🧚 INSTALLATION 🧚

Go see your node package manager manual... you got this, bestie 💖

For example:

npx marked-man simple.md

---

🌈 EXAMPLE 🌈

Wanna view this README as a man page? Run something like the following:

marked-man README.md | man /dev/stdin

ok that pipe into man /dev/stdin is genuinely such a slay, no notes 🎀

---

💅 AS MARKED EXTENSION 💅

import markedMan from 'marked-man';
import marked from 'marked';

marked.use(markedMan);

---

👑 SEE ALSO 👑

• Ronn
• Ronn-NG
• groff

---

💀 REPORTING BUGS 💀

See the marked-man repository. (Yep, that's the whole vibe — go check the repo, bestie.)

---

so like... that's literally the whole page. marked-man, version 2.1.1, from June 2026, General Commands Manual energy, and the manual name is MARKED-MAN(1) in case you forgot 💜 mwah, go write some man pages 🎀✨