cheapskate(1)

πŸ“¦ version 0.1.1.2, in fedora 43, fedora 44

πŸ’… cheapskate(1) β€” the manual page, but make it slay

okay bestie, sit down, hydrate, because we're talking about cheapskate, section 1 of the manual. she's a little markdown-to-HTML converter and she is, genuinely, iconic. no notes. πŸŽ€


✨ NAME ✨

cheapskate β€” convert markdown to HTML.

like. that's the whole job. markdown goes in, HTML comes out. she doesn't do your taxes, she doesn't fold your laundry, she converts markdown to HTML. periodt. πŸ’–


🌸 SYNOPSIS 🌸

cheapskate [options..] [file..]

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so here's the vibe: cheapskate takes your input text and turns it from markdown into HTML. and where does that input text come from, you ask? from stdin, or from any number of input files β€” your choice, bestie, she's flexible like that. πŸ’«

and the output? written to stdout. so you can pipe it, redirect it, hand it to your friend, whatever. main character energy fr fr.


πŸ‘‘ OPTIONS πŸ‘‘

one bullet per flag, all of them, no skipping, we're not that kind of girl:

  • -s, --sanitize β€” Sanitize raw HTML plus link and image attributes, so XSS attacks can't get in. protective queen behavior honestly 🫢
  • -e, --escape-raw-html β€” Escape all raw HTML.
heads up bestie: for safety, use --sanitize. this one is for the people who want to disallow raw HTML entirely, to enforce uniformity of formatting. different goal, different flag, iykyk.
  • -b, --hard-line-breaks β€” Treat all newlines as hard line breaks (<br /> tags in HTML). every newline gets its moment. every single one. πŸ’…
  • --debug β€” Print the container structure obtained from phase 1 of parsing. debugging only, babes β€” this is not for the general public. πŸ™ˆ
  • -h, --help β€” Print usage information. she's helping! 🌈
  • -V, --version β€” Print version. lowercase -v could never, it's capital -V around here. ⭐

πŸ’œ AUTHORS πŸ’œ

John MacFarlane. the icon. the legend. we stan. πŸ‘‘


πŸ”₯ SEE ALSO πŸ”₯

The cheapskate source code and all documentation may be downloaded from:

<http://github.com/jgm/cheapskate/>

go forth and download, bestie. 🧚


and that's the whole page, no cap. this was the cheapskate manual, dated January 4, 2014 β€” yeah she's an elder but she ate and left no crumbs. bye bestie, go convert some markdown πŸ’–βœ¨πŸŽ€πŸ¦‹πŸŒΈπŸ’…πŸ«Ά

πŸ“¦ where this page comes from