This is a tool to help work with inline math in markdown. Math can be frustrating in markdown, with some parsers using $ as a delimiter, some using $$ as a delimiter, others using a different delimiter, and then GitHub, which doesn't support inline math at all.

What can it do?

• Translate inline LaTeX math into embedded images for use with Github

• $lim_{x\to 2}f(x)$ ->

• Convert math delimiters from one to another

• $lim_{x\to 2}f(x)$ -> $$lim_{x\to 2}f(x)$$

What can't it do?

• Currently cannot do LaTeX style delimiters (e. g. "\[x^2\]")
• Currently does not employ any heuristics, Pandoc style heuristics for dollar-sign delimiters is planned
• Does not parse the markdown, only performs basic string substitution

Usage

Note: Currently has been tested on macOS Catalina, Windows 10, and Android 7.0.0 (via termux)

mdMathTool has three modes: Simple Mode, Advanced Mode, and Batch Mode:

Simple Mode prompts the user for all values, and can be run with:

$ mdmathtool -s

Advanced Mode takes all arguments when the command is run, and can be run as follows:

$ mdmathtool -a <source filepath> <destination filepath> <source delimiter> <destination delimiter>

Batch Mode is similar to Advanced Mode, but processes whole folders:

$ mdmathtool -b <source folder> <append to filename> <source delimiter> <destination delimiter>

Quick Mode will convert a given LaTeX expression into a github-friendly image embed, it can either be run with no argument, and the user will be prompted:

$ mdmathtool -q

Or the equation can be passed in directly through the command line (equation MUST be wrapped in quotations)

$ mdmathtool -q <equation>

Notes:

• Source and destination delimiters must be surrounded by ' ' (e. g. '$')
• Source filepath and destination file path cannot be the same file
• mdMathTool will create the destination filepath specified if it does not already exist
• The append to file name argument appends the specified string directly after the filename, before the extension. It cannot be left empty.

Installation

Java(Universal):

Requires >=Java 1.8

Download the latest jar release from the Releases page.

Navigate to the directory you downloaded the file to and open a terminal there.

Run using:

java -jar mdMathTool_<version>.jar <arguments>

Homebrew(macOS, Linux):

brew install sohalsdr/tap/mdmathtool

Run using:

mdmathtool <arguments>

Scoop(Windows)

scoop bucket add scoop-sohalsdr https://github.com/sohalsdr/scoop-sohalsdr

scoop install mdmathtool

Run using:

mdmathtool <arguments>