MARKED(1)

📦
version 18.0.6+~cs7.2.17 · 3 versions
, in ubuntu stonking

💖 MARKED(1) 💖

okay bestie, listen up — this is marked, the manual page, and it is literally the moment. it lives in the General Commands Manual section of your man pages, and we're gonna get you fluent in it. slay.

🌸 NAME 🌸

marked — a javascript markdown parser 🦋

like. a markdown parser. in javascript. that's the whole vibe. no cap.

✨ SYNOPSIS ✨

marked [-o <output file>] [-i <input file>] [-s <markdown string>] [-c
<config file>] [--help] [--version] [--tokens] [--no-clobber]
[--pedantic] [--gfm] [--breaks] [--no-etc...] [--silent] [filename]

look at all those little flags, they're giving ✨options✨ and honestly? obsessed. 👑

💅 DESCRIPTION 💅

marked is a full-featured javascript markdown parser, and bestie, it was built for speed. periodt. ⚡

it also ships with multiple GFM features, so github-flavored markdown? yeah. handled. 💖

🍓 EXAMPLES 🍓

here's the girlies doing the thing, fr fr:

  cat in.md | marked > out.html
  echo "hello *world*" | marked
  marked -o out.html -i in.md --gfm
  marked --output="hello world.html" -i in.md --no-breaks

see how casual that was? pipe it, echo it, flag it up, quote your filenames with spaces in em. iconic. 😌

🎀 OPTIONS 🎀

  • -o, --output [output file] — tell it where to write the output. and if you don't specify anything? it just writes to stdout, no drama. 💫
  • -i, --input [input file] — tell it where to read from. if you don't pass this, it'll use the last argument as the input file instead. and if there's literally no input file at all? it reads from stdin. flexible queen. 🫶
  • -s, --string [markdown string] — instead of a file, just hand it a raw string of markdown. yes, inline. yes, chaotic. yes, we love it. ✨
  • -c, --config [config file] — point it at a config file to use instead of the default, which is ~/.marked.json or ~/.marked.js or ~/.marked/index.js. three whole defaults, she's prepared. 🎀
  • -t, --tokens — output a token list instead of html. for when you wanna see the ✨internals✨. 🔥
  • -n, --no-clobber — do not overwrite the output if it already exists. protective. we stan a boundaries-having binary. 🙈
  • --pedantic — conform to the obscure parts of markdown.pl as much as possible. and ngl, it does not fix the original markdown bugs. it preserves them. respectfully. 💀
  • --gfm — enable github flavored markdown. the glow-up. ⭐
  • --breaks — enable GFM line breaks. heads up though: this only works with the gfm option. no gfm, no breaks, that's the rule. 💅
  • --no-breaks, -no-etc... — the inverse of any of the marked options listed above. flip the switch, undo the thing. 🦋
  • --silent — silence error output. shhh. 🤫
  • -h, --help — display help information. your girl is here to help. 🫶

🧚 CONFIGURATION 🧚

for configuring and running it programmatically. yes, we're getting code-y. no, i'm not scared.

💜 Example

import { Marked } from 'marked';
const marked = new Marked({ gfm: true });
marked.parse('*foo*');

look at her. new Marked({ gfm: true }) and then marked.parse('*foo*'). clean, gorgeous, no notes. ✨

💀 BUGS 💀

please report any bugs to https://github.com/markedjs/marked

(not me manifesting a bug-free experience but okay bestie, if something's cursed, that's the spot. 🐛)

👑 LICENSE 👑

Copyright (c) 2018+, MarkedJS. (MIT License) Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License)

both MIT, both icons. 🎀

🌈 SEE ALSO 🌈

go read those too, iykyk. 💖

and that's the whole page, bestie!! this was marked 18.0.6, dated August 2026 — so yes, she's fresh off the press and lowkey thriving. now go parse some markdown. slay, periodt, bye!! 💅✨🦋

📦 where this page comes from