MARKDOWN-CALIBRE(1)

πŸ’– MARKDOWN-CALIBRE(1) πŸ’–

okay bestie, welcome to the markdown-calibre era β€” it's a User Commands page, and it is literally the moment markdown becomes ✨markup✨.


🌸 NAME 🌸

markdown-calibre β€” convert Markdown text to XHTML/HTML

like. that's it. that's the whole job. and she ATE. πŸ’…


πŸŽ€ SYNOPSIS πŸŽ€

markdown-calibre [options] [INPUTFILE]

(if you don't hand her an INPUTFILE, she just assumes STDIN. no questions asked, she's chill like that 🫢)


πŸ¦‹ DESCRIPTION πŸ¦‹

It's a Python implementation of John Gruber's Markdown. not a vibe, a lifestyle.

https://python-markdown.github.io/

that's the link, go be nosy, she's iconic.


✨ OPTIONS ✨

okay so here's the menu, no skips, we're reading every single one fr fr:

  • --version β€” shows the program's version number and then dips. bye! πŸ‘‹
  • -h, --help β€” shows this help message and exits. the "help me bestie" button.
  • -f OUTPUT_FILE, --file=OUTPUT_FILE β€” write the output to OUTPUT_FILE. if you don't say anything, it defaults to STDOUT. she's not shy, she'll just say it out loud. πŸ—£οΈ
  • -e ENCODING, --encoding=ENCODING β€” the encoding for input and output files. both. matching. couple goals. πŸ’ž
  • -o OUTPUT_FORMAT, --output_format=OUTPUT_FORMAT β€” pick your output format: 'xhtml' (the default, the main character πŸ‘‘) or 'html'.
  • -n, --no_lazy_ol β€” observe the number of the first item of ordered lists. yes she's counting. she's watching. πŸ‘€
  • -x EXTENSION, --extension=EXTENSION β€” load extension EXTENSION. plug it in, let it cook. πŸ”Œ
  • -c CONFIG_FILE, --extension_configs=CONFIG_FILE β€” read extension configs from CONFIG_FILE. now listen, CONFIG_FILE has to be JSON or YAML format. YAML format requires that a python YAML library be installed, so if it's not, that's a whole thing. 😭 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. and β€” this part matters β€” the extensions must also be loaded with the --extension option. like, both. you need both. don't come back mad at me.
  • -q, --quiet β€” suppress all warnings. shhh. 🀫
  • -v, --verbose β€” print all warnings. tell me EVERYTHING. πŸ—£οΈπŸ”₯
  • --noisy β€” print debug messages. louder. LOUDER. she's giving main character energy and honestly? respect. πŸ“’

🌈 SEE ALSO 🌈

  • calibre(1) β€” her big sister, go say hi πŸ’œ

that's the whole page bestie, you're so ready. no cap, you understood all of it. periodt. 🧚

β€” with love from markdown-calibre, August 2021 πŸ’–βœ¨πŸŽ€πŸ¦‹πŸŒΈπŸ’…πŸ«Ά