M2R(1)

📦
version 0.3.1 · 2 versions
, in debian bookworm, ubuntu noble

✨ M2R(1) ✨

okay bestie, so this is m2r, a lil command-line tool that lives in the User Commands section of the manual (that's the (1) btw, iykyk) 💖

🌸 NAME 🌸

m2r — the command-line tool that converts markdown that has reStructuredText (rst) inside it into reStructuredText 🦋

no cap, that's the whole job. it takes your md and hands you back rst, and honestly? it ate.

💅 DESCRIPTION 💅

here's how you run it, and yes it's giving:

usage: m2r [-h] [--overwrite] [--dry-run] [--no-underscore-emphasis]
       [--parse-relative-links] [--anonymous-references]
       [--disable-inline-math] [input_file ...]

🎀 positional arguments:

  • input_file — the files you wanna convert into reST format 💖 (you can pass more than one, she's flexible like that)

🧚 options:

  • -h, --help — shows you this help message and then dips. classic. ✨
  • --overwrite — overwrites the output file without confirmation 👀 no "are you sure?" bestie, it just goes. be careful with this one fr fr
  • --dry-run — prints the conversion result instead of saving it to an output file 🌈 perfect for a lil vibe check before you commit
  • --no-underscore-emphasis — tells her not to use underscore (_) for emphasis 🙈
  • --parse-relative-links — parses relative links into ref or doc directives 🔥
  • --anonymous-references — uses anonymous references in the generated rst 👑
  • --disable-inline-math — disables parsing inline math 💀 (the math girlies are gonna be so sad but okay)
ngl, if you're converting docs and you want the rst to come out clean on the first try, --dry-run is your bestie before you let --overwrite anywhere near your files 💜

and that's the whole page! stay slay, convert responsibly 🫶

m2r 0.3.1 🌸 January 2023 🎀 and yeah, it's filed under M2R(1) — mwah, love u, bye 💅✨

📦 where this page comes from