MARKDOWN_PY(1)

✨ MARKDOWN_PY(1) ✨

okay bestie, gather round, because we're talking about markdown_py β€” it's a Python implementation of John Gruber's Markdown, and it's literally the moment. πŸ’–


πŸŽ€ SYNOPSIS πŸŽ€

markdown_py [options] [INPUT_FILE]
(STDIN is assumed if no INPUT_FILE is given)

so like. you give it options, maybe a file, and if you don't give it a file it just reads from STDIN like the chill little icon it is. periodt. πŸ’…


🌸 DESCRIPTION 🌸

Command-line Markdown compiler based on python-markdown module, with extensions support. she compiles markdown from the command line and she supports extensions, okay?? main character behavior.

Deprecated! Use python3 -m markdown instead, which accepts the same options. like, no cap, that's the move now. this one still works and takes all the same flags, but the glow-up version is python3 -m markdown. 😭

πŸ‘‘ OPTIONS πŸ‘‘

here's the full roster, no skips, no cuts, every single one:

  • --version β€” Show program's version number and exit. cute lil "who am I" moment. πŸ¦‹
  • -h, --help β€” Show the help message and exit. when you're lost, she's got you. 🫢
  • -f OUTPUT_FILE, --file=OUTPUT_FILE β€” Write output to OUTPUT_FILE. Defaults to STDOUT. so if you don't tell her where to put it, it's going straight to your screen, bestie. ✨
  • -e ENCODING, --encoding=ENCODING β€” Encoding for input and output files. tell her what language the bytes are speaking. πŸ’œ
  • -o OUTPUT_FORMAT, --output_format=OUTPUT_FORMAT β€” Use output format 'xhtml' (default) or 'html'. two flavors, pick your vibe. πŸ“
  • -n, --no_lazy_ol β€” Observe number of first item of ordered lists. she'll actually respect where your ordered list starts. so real of her. πŸ”₯
  • -x EXTENSION, --extension=EXTENSION β€” Load extension EXTENSION. stack 'em up, more extensions more fun. 🌈
  • -c CONFIG_FILE, --extension_configs=CONFIG_FILE β€” Read extension configurations from CONFIG_FILE. CONFIG_FILE must be of JSON or YAML format. YAML format requires python3-yaml package to be installed. The parsed JSON or YAML must result in a Python dictionary which would be accepted by the 'extension_configs' keyword on the markdown.Markdown class. The extensions must also be loaded with the --extension option. so like β€” this one is doing a LOT, she's the overachiever of the group. and heads up: if you go the YAML route you need the python3-yaml package installed, no exceptions. also the config alone isn't enough, you still gotta load the extensions with --extension. iykyk. πŸ’…
  • -q, --quiet β€” Suppress all warnings. shhh. nothing to see here. πŸ™ˆ
  • -v, --verbose β€” Print all warnings. okay NOW we're yapping, tell me everything. 😭
  • --noisy β€” Print debug messages. she's not just talking, she's oversharing. πŸ’€

and that's the whole page, bestie. this one comes from the General Commands Manual, filed under markdown_py(1) β€” same section number, same name, she's iconic and she knows it. mwah. πŸ’–βœ¨πŸŽ€