Jekyll Maths LaTeX to Image

A complete solution for rendering LaTeX mathematical expressions in Jekyll sites as SVG/PNG images, ensuring consistent display across all platforms and browsers.

To see a working example, clone the example branch:

# Clone the example branch
git clone -b example https://github.com/vrocky/jekyll-maths-latex-to-image.git
cd jekyll-maths-latex-to-image

# Install dependencies
npm install
bundle install

# Run the example site
bundle exec jekyll serve

The example site demonstrates:

• Basic math expressions
• Complex equations
• Different rendering options
• Custom configurations

Visit https://github.com/vrocky/jekyll-maths-latex-to-image/tree/example for more details.

• Ruby >= 2.5.0
• Node.js >= 14.0.0
• LaTeX installation (TeXLive recommended)

This project consists of two packages that work together:

1. A Ruby gem (Jekyll plugin)
2. A Node.js support package

Add the Node.js package to your Jekyll site's dependencies:

cd your-jekyll-site
npm init # if you haven't already
npm install --save jeykll-maths-latex-to-image-node-support

mAdd this to your Jekyll site's _config.yml:

texsvg_math_renderer:
  node_modules_path: "./node_modules"  # Path to your node_modules directory

Add to your Jekyll site's Gemfile:

gem 'jekyll-maths-latex-to-image'

Then add to your _config.yml:

plugins:
  - jekyll-maths-latex-to-image

jekyll-maths-latex-to-image:
  enabled: true              # Enable/disable the plugin
  path: /assets/img/math    # Path for generated images
  format: both             # 'svg', 'png', or 'both'

Install the gem:

bundle install

1. Start using LaTeX math in your Markdown files:

   Inline math: $E = mc^2$
   
   Display math:
   $$
   \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
   $$

2. Build your Jekyll site:

   bundle exec jekyll build

   or serve locally:

   bundle exec jekyll serve

The plugin will automatically:

• Convert LaTeX expressions to SVG/PNG
• Cache the generated images
• Replace LaTeX with image tags in the HTML output

If you encounter issues:

1. Verify both packages are installed:

   gem list jekyll-maths-latex-to-image
   npm list -g jeykll-maths-latex-to-image-node-support

2. Check LaTeX installation:

   tex --version

3. Ensure write permissions for the image output directory

MIT License - see LICENSE file for details.