Project

## jektex

0.01
The project is in a healthy, maintained state
Highly optimized and cached latex server side rendering for Jekyll with macros and dynamic output
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
Popularity
Development
Primary Language
Ruby
GPL-3.0-or-later
Dependencies

~> 2.0, >= 2.0.0

~> 3.0, >= 3.0.0
~> 2.8, >= 2.8.1
~> 4.3, >= 4.3.4

# Jektex

A Jekyll plugin for blazing-fast server-side cached LaTeX rendering, with support for macros. Enjoy the comfort of LaTeX and Markdown without cluttering your site with bloated JavaScript.

## Features

• Renders LaTeX formulas during Jekyll rendering
• Works without any client-side JavaScript
• Is faster than any other server-side Jekyll LaTeX renderer
• Supports user-defined global macros
• Has I/O-efficient caching system
• Dynamically informs about the number of expressions during rendering
• Is very easy to setup
• Doesn't interfere with Jekyll workflow and project structure
• Marks invalid expressions in document, printing its location during rendering
• Is highly configurable with sensible defaults
• Makes sure that cache does not contain expression rendered with outdated configuration
• Supports two major LaTeX notations

## Usage

Jektex supports both the built-in Kramdown math notation, and the newer LaTeX-only math notation.

### Kramdown notation

Inline formula
Put formula between two pairs of dolar signs ($$) inside of paragraph. Lorem ipsum dolor sit amet, consectetur$$e^{i\theta}=\cos(\theta)+i\sin(\theta)$$adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Display formula Put formula between two pairs of dolar sings ($$) and surround it with two empty lines.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
incididunt ut labore et dolore magna aliqua.

$$\left[ \frac{-\hbar^2}{2\mu}\nabla^2 + V(\mathbf{r},t)\right] \Psi(\mathbf{r},t)$$

Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex
ea commodo consequat.

Why Jektex does not use conventional single $for inline formulas and double$\$ for display mode?
This is how kramdown(Jekyll's markdown parser) works so I decided to respect this convention. It makes this plugin more consistent and universal.

### LaTex math mode notation

Inline formula
Put formula between two escaped brackets . Its position in the text does not matter.

Lorem ipsum dolor sit amet, consectetur $$e^{i\theta}=\cos(\theta)+i\sin(\theta)$$
adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Display formula
Put formula between two escaped square brackets . Its position in the text does not matter.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
incididunt ut labore et dolore magna aliqua.

$\left[ \frac{-\hbar^2}{2\mu}\nabla^2 + V(\mathbf{r},t)\right] \Psi(\mathbf{r},t)$

Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex
ea commodo consequat.

### Config

Jektex si highly configurable via your _config.yml file.

Disabling cache
You can disable caching with disable_disk_cache = true in _config.yml. Caching is enabled by default. You can find more information on Jekyll's official website.

Setting cache location
By default, Jektex cache will be saved in .jekyll-cache directory. This results in its deletion when you call jekyll clean. To prevent cache deletion or to change the cache location, you can specify cache_dir in _config.yml:

# Jektex cache dir location
jektex:
cache_dir: ".jektex-cache"

Ignoring files
By default, Jektex tries to render LaTeX in all files rendered by Jekyll. This can sometimes be undesirable, for example when rendering an RSS feed with excerpts containing LaTeX. Jektex solves this by using the ignore option:

# Jektex ignore files
jektex:

You can use conventional wild cards using *. This example configuration ignores all .xml files, README.md and all files in the _drafts directory.

Another way to ignore specific posts is setting the jektex attribute in front matter to false:

---
ttle: "How Jektex works"
category: "Development"
jektex: false
layout: post
---

Setting jektex tag to true or not setting at all will result in Jektex rendering LaTeX expressions in that post.

Using macros
You can define global macros:

# Jektex macros
jektex:
macros:
- ["\\Q", "\\mathbb{Q}"]
- ["\\C", "\\mathbb{C}"]

And yes, you have to escape the backlash (\) with another backlash. This is due to the yaml specification.

Complete examples
Recommended config:

jektex:
cache_dir: ".jektex-cache"
ignore: ["*.xml"]
macros:
- ["\\Q", "\\mathbb{Q}"]
- ["\\C", "\\mathbb{C}"]

Having no configuration is equivalent to this:

jektex:
cache_dir: ".jekyll-cache"
ignore: []
macros: []

## Installation

This plugin is available as a RubyGem.

Using bundler

group :jekyll_plugins do
gem "jektex"
end

and run bundle install

Without bundler
Run gem install jektex

After installation