nglaeser/gh-md-test

Automatically render LaTeX in GH markdown

gh-md-test

Using @jeremy-rifkin's solution.

Usage

Install the markdown-math-gh-compiler tool:

npm install -g markdown-math-gh-compiler

Compile a file with LaTeX syntax into one with embedded images of the formulas (using GitHub's renderer) with

markdown-math-gh-compiler myfile_latex.md -o myfile.md

Note: This tool seems to dislike the markdown syntax of using two spaces at the end of a line to create a new line (a new paragraph, in HTML-speak). For line breaks, leave an empty line instead (underscore indicates a space):

# don't do this
This is my first line.__
This is a new line.

# do this
This is my first line.

This is a new line.

Pre-Commit Hook

This repo uses a pre-commit Git hook to automate this process. The source code with LaTeX syntax is found in the *_latex.md files, and the pre-commit script compiles these files into *.md files with the embedded images instead.

The script also preserves the directory structure, mirroring the directory structure in src to the root directory (but with compiled versions instead of the source files); see the behavior with this and this test file (note the link in the source -- in this case src/README_latex.md -- are to the compiled versions).

The pre-commit script (which is run before every git commit) is pre-commit.sh. If you clone this repo and wish to use this Git hook as well, "install" the hook by running

chmod +x pre-commit.sh
ln -s ../../pre-commit.sh .git/hooks/pre-commit

in the root of this repo.

(If you're confused about why the source file is prepended by ../../ in the ln command, remember that the source file location must be given relative to the link name.)

Example

Important: if you are using GitHub in dark mode, the equations will not be visible.

My favorite equation is .

Here it is centered:

Note: The source for this is $$e^{i\pi} = -1$$. Notice the absence of line breaks before/after $$; the following may not render correctly:

$$
e^{i\pi} = -1
$$

---

Other potential tools:

• VSCode plugin to (manually and on a per-equation basis) do the same thing: math-to-image. It also includes an option to create a local SVG instead.
• Website that gives you both MD and HTML syntax for embedding the equation image
• Another web app that does the same thing
• github-texify