CODEWITHSUNDEEP
jekyllmathjaxkramdown
han jin
han jin

Reputation: 75

An Latex Equation Would Not Render in Jekyll (kramdown engine)

I am using Jekyll + kramdown to render my blog. But I find this particular equation not renderable, it either appeared in raw latex code, or just blank, depending on how many white spaces I put around the dollar signs. All other equations have been rendered fine.

Here is how I insert the equation:

$$S_S \to (([tdh],)^{*} [tdh]&)^{?} [tdh]$$

Is it some settings of kramdown I need to configure? I have tried this code on MathJax website demo, and it was rendered fine.

Thanks!

Upvotes: 0

Views: 634

Answers (1)

han jin
han jin

Reputation: 75

I am trying to answer my own question. After delving into the guidelines of MathJax and Kramdown, and doing some experiments, I found the problem, and it is not related to kramdown.

The problem is caused by the ampersand character: &. In LaTeX, it is valid to write an ampersand character, except when inside special environments, and it will be rendered correctly. However, as in markdown blogs, the source code is processed by browsers before math renderers, so the & character is misinterpreted, causing it not correctly read by MathJax. I mostly use LaTeX in my life, so I thought a valid LaTeX expression should be a valid markdown math block as well and overlooked the issue special characters when I asked this question. The online MathJax renderers can render the bare & correctly, probably because entered text are not first processed by the browser.

The solution is to escape the ampersand, i.e. write \&, and for double insurance, surround it by white spaces, so the browser will treat it as a normal text.

Similar problems will occur to other characters that have special meanings in html, like < and >. The same solution applies, that the character has to be escaped or if that is not possible, expressed in other ways.

Upvotes: 0

Related Questions