KATEX(1)

πŸ’– KATEX(1) β€” the manual page, but make it cute πŸ’–

okay so bestie, welcome to the katex manual page β€” it's a fast, easy-to-use JavaScript library for TeX math rendering, and it's giving absolute icon behaviour. this is the User Commands section of the manual, and honestly? you're gonna eat this up. πŸŽ€


✨ NAME ✨

katex β€” a fast, easy-to-use JavaScript library for TeX math rendering. literally that's the whole vibe. no cap. πŸ¦‹


🌸 SYNOPSIS 🌸

cli [options]

yep. that's it. that's the whole thing. she's simple like that. πŸ’…


πŸ‘‘ OPTIONS πŸ‘‘

every single flag, coming at you, in order, no skips, no skips, periodt. 🫢

  • -V, --version β€” prints out the version number. that's it, that's the job. ⭐
  • -d, --display-mode β€” renders the math in display mode, which puts the math in display style (so \int and \sum are large, for example), and centers the math on the page on its own line. main character energy for your equations, fr fr. πŸ‘‘
  • -F, --format <type> β€” decides the markup language of the output. which language? that's what type is for, bestie. πŸ’œ
  • --leqno β€” renders display math in leqno style, aka left-justified tags. tags on the left, like a rebel. ✨
  • --fleqn β€” renders display math flush left. she's not centered, she's left, and she's thriving. 🌸
  • -t, --no-throw-on-error β€” instead of throwing a ParseError exception when it hits an error, it renders the errors instead (in the color given by --error-color). so no crash, just colorful little oopsies. 😭
  • -c, --error-color <color> β€” a color string in the format 'rgb' or 'rrggbb' (no #, bestie, do NOT put a hash). this option determines the color of errors rendered by the -t option. 🎨
  • -m, --macro <def> β€” define a custom macro of the form '\foo:expansion' (use multiple -m arguments for multiple macros). default: []. stack 'em up, girlie. πŸ“
  • --min-rule-thickness <size> β€” specifies a minimum thickness, in ems, for fraction lines, \sqrt top lines, {array} vertical lines, \hline, \hdashline, \underline, \overline, and the borders of \fbox, \boxed, and \fcolorbox. every line gets a minimum glow-up. ✨
  • -b, --color-is-text-color β€” makes \color behave like LaTeX's 2-argument \textcolor, instead of LaTeX's one-argument \color mode change. two args, not one. iconic. πŸ’…
  • -S, --strict β€” turns on strict / LaTeX faithfulness mode, which throws an error if the input uses features that are not supported by LaTeX. she's a rule-follower and honestly? respect. 🧚
  • -T, --trust β€” trust the input, enabling all HTML features such as \url. handing over the aux cord, no questions asked. πŸ”₯
  • -s, --max-size <n> β€” if non-zero, all user-specified sizes, e.g. in \rule{500em}{500em}, will be capped to maxSize ems. otherwise, elements and spaces can be arbitrarily large. (yes, arbitrarily. chaos permitted.) πŸ’€
  • -e, --max-expand <n> β€” limits the number of macro expansions to the specified number, to prevent e.g. infinite macro loops. if set to Infinity, the macro expander will try to fully expand as in LaTeX. πŸ‘‘
  • -f, --macro-file <path> β€” reads macro definitions, one per line, from the given file. macros, but make it a whole file. πŸ“„
  • -i, --input <path> β€” reads LaTeX input from the given file. feed her. πŸ“
  • -o, --output <path> β€” writes html output to the given file. bye bestie, go live your truth on disk. πŸ’–
  • -h, --help β€” displays help for command. the classic. the legend. 🫢

lowkey important reminder: the error color string is 'rgb' or 'rrggbb' with no #. i'm not kidding. don't do it. πŸ™ˆ

and that's the whole page, bestie!! πŸ’œ this was katex 0.16.10, dated March 2024 β€” thanks for reading, mwah, slay, go render some math. πŸŽ€βœ¨πŸ¦‹πŸŒˆπŸ‘‘πŸ’…

πŸ“¦ where this page comes from