MARUKU(1)

💖 MARUKU(1) 💖

okay so bestie, welcome to the maruku manual page — it's in the General Commands Manual section, and it's literally the whole vibe of turning markdown into other stuff. sit down, grab a strawberry 🍓, we're doing this.

✨ NAME ✨

maruku — converts markdown files to various output. that's it, that's the job, and she ate. 💅

✨ SYNOPSIS ✨

maruku [options] [file1.md [file2.md ...]]

✨ DESCRIPTION ✨

so maruku is a markdown interpreter, no cap. you hand her files written in the markdown language and she transforms them into HTML, TeX of PDF (using pdflatex). iconic behaviour honestly.

and here's the little plot twist 🫶: if you don't give her a file on the command-line, maruku acts as a filter — she takes standard input and converts it to standard output. main character energy, works with pipes, obsessed.

✨ OPTIONS ✨

• -v, --[no-]verbose — run verbosely. she will tell you things. 👀
• -u, --[no-]unsafe — use unsafe features. bestie be careful with this one, it's literally called unsafe 😭
• -b — break on error. no pushing through, we stop right there.
• -i, --math-images _ENGINE_ — uses _ENGINE_ to render TeX to PNG. 🎀
• -m, --math-engine _ENGINE_ — uses _ENGINE_ to render MathML.
• -o, --output _FILE_ — output filename. your file, your name, your rules.
• --pdf — creates PDF output using pdflatex. please see the NOTE below, it matters fr fr 👇
• --s5 — write S5 slideshow. presentation slay ✨
• --html — write HTML output.
• --html-frag — write the contents of the BODY. just the inside bits, no wrapper, lowkey minimalist 💜
• --tex — write LaTeX.
• --inspect — shows the parsing result. she's showing you her work 🧚
• --version — show version.

✨ SEE ALSO ✨

• marutex(1)
• pdflatex(1)

go read those too, iykyk 🌈

✨ NOTE ✨

an important note for debian users, and i need you to actually read this one: to prevent a lightweight library such as libmaruku-ruby to pull in heavy dependencies like texlive, libmaruku-ruby does not depend on texlive (but only recommends it). which means — and this is the part that hurts 😭 — if you do not install texlive, you will not have PDF output. no texlive, no PDF. periodt.

✨ AUTHOR ✨

maruku was written by Andrea Censi <andrea@rubyforge.org>. 🫶

this manual page was written by Vincent Fourmond <fourmond@debian.org>, for the Debian project (but may be used by others). iconic of them honestly 💖

and that's the whole page bestie!! this version is the MARUKU(1) one, dated May 27, 2007 🌸 go forth and convert some markdown, you've got this 👑✨