Merge branch 'master' of github.com:waylonflinn/markdown-it-katex
This commit is contained in:
Waylon Flinn
commit
d8f41295cb
4 changed files with 207 additions and 144 deletions
11
README.md
11
README.md
|
|
@ -75,6 +75,17 @@ $$\begin{array}{c}
|
||||||
\end{array}$$
|
\end{array}$$
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Syntax
|
||||||
|
|
||||||
|
Math parsing in markdown is designed to agree with the conventions set by pandoc:
|
||||||
|
|
||||||
|
Anything between two $ characters will be treated as TeX math. The opening $ must
|
||||||
|
have a non-space character immediately to its right, while the closing $ must
|
||||||
|
have a non-space character immediately to its left, and must not be followed
|
||||||
|
immediately by a digit. Thus, $20,000 and $30,000 won’t parse as math. If for some
|
||||||
|
reason you need to enclose text in literal $ characters, backslash-escape them and
|
||||||
|
they won’t be treated as math delimiters.
|
||||||
|
|
||||||
## Math Syntax Support
|
## Math Syntax Support
|
||||||
|
|
||||||
KaTeX is based on TeX and LaTeX. Support for both is growing. Here's a list of
|
KaTeX is based on TeX and LaTeX. Support for both is growing. Here's a list of
|
||||||
|
|
|
||||||
278
index.js
278
index.js
|
|
@ -7,167 +7,191 @@ It differs in that it takes (a subset of) LaTeX as input and relies on KaTeX
|
||||||
for rendering output.
|
for rendering output.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/*jslint node: true */
|
||||||
'use strict';
|
'use strict';
|
||||||
|
|
||||||
var katex = require('katex');
|
var katex = require('katex');
|
||||||
|
|
||||||
//return if we have valid delimiter, '$', is in the position.
|
// Test if potential opening or closing delimieter
|
||||||
function isValidDelim(state) {
|
// Assumes that there is a "$" at state.src[pos]
|
||||||
var lastChar, secondLastChar, nextChar, pos = state.pos;
|
function isValidDelim(state, pos) {
|
||||||
|
var prevChar, nextChar,
|
||||||
|
max = state.posMax,
|
||||||
|
can_open = true,
|
||||||
|
can_close = true;
|
||||||
|
|
||||||
if(state.src[pos]!=='$'){
|
prevChar = pos > 0 ? state.src.charCodeAt(pos - 1) : -1;
|
||||||
return false; //the character $ must be in its position.
|
nextChar = pos + 1 <= max ? state.src.charCodeAt(pos + 1) : -1;
|
||||||
}
|
|
||||||
|
|
||||||
secondLastChar= pos > 1 ? state.src[pos-2] : ' '
|
// Check non-whitespace conditions for opening and closing, and
|
||||||
lastChar = pos > 0 ? state.src[pos-1] : ' '
|
// check that closing delimeter isn't followed by a number
|
||||||
nextChar = pos + 1 < state.src.length ? state.src[pos+1] : ' '
|
if (prevChar === 0x20/* " " */ || prevChar === 0x09/* \t */ ||
|
||||||
|
(nextChar >= 0x30/* "0" */ && nextChar <= 0x39/* "9" */)) {
|
||||||
|
can_close = false;
|
||||||
|
}
|
||||||
|
if (nextChar === 0x20/* " " */ || nextChar === 0x09/* \t */) {
|
||||||
|
can_open = false;
|
||||||
|
}
|
||||||
|
|
||||||
if(
|
return {
|
||||||
lastChar === '\\' //$ we found was escaped.
|
can_open: can_open,
|
||||||
|| (lastChar === '$' && secondLastChar !== '\\') // $ we found was after $ but not escaped.
|
can_close: can_close
|
||||||
|| nextChar === '$' //$ we found was actually block delimiter $$.
|
};
|
||||||
)
|
|
||||||
{
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
return true;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function math_inline(state, silent){
|
function math_inline(state, silent) {
|
||||||
var start, found = false, token;
|
var start, match, token, res, pos, esc_count;
|
||||||
if(silent) { return false; }
|
|
||||||
|
|
||||||
start = state.pos;
|
if (state.src[state.pos] !== "$") { return false; }
|
||||||
if(state.src[start] !== '$'){ return false; }
|
|
||||||
if(!isValidDelim(state)){
|
|
||||||
state.pos += 1;
|
|
||||||
state.pending += '$';
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
state.pos+=1;
|
|
||||||
|
|
||||||
while(state.pos < state.posMax){
|
res = isValidDelim(state, state.pos);
|
||||||
if(isValidDelim(state)){
|
if (!res.can_open) {
|
||||||
found = true;
|
if (!silent) { state.pending += "$"; }
|
||||||
break;
|
state.pos += 1;
|
||||||
|
return true;
|
||||||
}
|
}
|
||||||
state.md.inline.skipToken(state);
|
|
||||||
}
|
|
||||||
if(!found){
|
|
||||||
// Parser failed to find closing delimiter, so it is not a valid math
|
|
||||||
state.pos = start;
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (start + 1 === state.pos) {
|
// First check for and bypass all properly escaped delimieters
|
||||||
// There is nothing between the delimiters -- don't match.
|
// This loop will assume that the first leading backtick can not
|
||||||
state.pos = start;
|
// be the first character in state.src, which is known since
|
||||||
return false;
|
// we have found an opening delimieter already.
|
||||||
}
|
start = state.pos + 1;
|
||||||
|
match = start;
|
||||||
|
while ( (match = state.src.indexOf("$", match)) !== -1) {
|
||||||
|
// Found potential $, look for escapes, pos will point to
|
||||||
|
// first non escape when complete
|
||||||
|
pos = match - 1;
|
||||||
|
while (state.src[pos] === "\\") { pos -= 1; }
|
||||||
|
|
||||||
//found the closing delimiter and state.pos is pointing it
|
// Even number of escapes, potential closing delimiter found
|
||||||
token = state.push('math_inline','math',0);
|
if ( ((match - pos) % 2) == 1 ) { break; }
|
||||||
token.content = state.src.slice(start+1,state.pos).trim();
|
match += 1;
|
||||||
token.markup = '$';
|
}
|
||||||
|
|
||||||
state.pos += 1;
|
// No closing delimter found. Consume $ and continue.
|
||||||
return true;
|
if (match === -1) {
|
||||||
|
if (!silent) { state.pending += "$"; }
|
||||||
|
state.pos = start;
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check if we have empty content, ie: $$. Do not parse.
|
||||||
|
if (match - start === 0) {
|
||||||
|
if (!silent) { state.pending += "$$"; }
|
||||||
|
state.pos = start + 1;
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check for valid closing delimiter
|
||||||
|
res = isValidDelim(state, match);
|
||||||
|
if (!res.can_close) {
|
||||||
|
if (!silent) { state.pending += "$"; }
|
||||||
|
state.pos = start;
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!silent) {
|
||||||
|
token = state.push('math_inline', 'math', 0);
|
||||||
|
token.markup = "$";
|
||||||
|
token.content = state.src.slice(start, match);
|
||||||
|
}
|
||||||
|
|
||||||
|
state.pos = match + 1;
|
||||||
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
function math_block(state, start, end, silent){
|
function math_block(state, start, end, silent){
|
||||||
var firstLine, lastLine, next, lastPos, found = false, token,
|
var firstLine, lastLine, next, lastPos, found = false, token,
|
||||||
pos = state.bMarks[start] + state.tShift[start],
|
pos = state.bMarks[start] + state.tShift[start],
|
||||||
max = state.eMarks[start]
|
max = state.eMarks[start]
|
||||||
|
|
||||||
if(pos + 2 > max){ return false; }
|
if(pos + 2 > max){ return false; }
|
||||||
if(state.src.slice(pos,pos+2)!=='$$'){ return false; }
|
if(state.src.slice(pos,pos+2)!=='$$'){ return false; }
|
||||||
|
|
||||||
pos += 2;
|
pos += 2;
|
||||||
firstLine = state.src.slice(pos,max);
|
firstLine = state.src.slice(pos,max);
|
||||||
|
|
||||||
if(silent){ return true; }
|
if(silent){ return true; }
|
||||||
if(firstLine.trim().slice(-2)==='$$'){
|
if(firstLine.trim().slice(-2)==='$$'){
|
||||||
// Single line expression
|
// Single line expression
|
||||||
firstLine = firstLine.trim().slice(0, -2);
|
firstLine = firstLine.trim().slice(0, -2);
|
||||||
found = true;
|
found = true;
|
||||||
}
|
|
||||||
|
|
||||||
for(next = start; !found; ){
|
|
||||||
|
|
||||||
next++;
|
|
||||||
|
|
||||||
if(next >= end){ break; }
|
|
||||||
|
|
||||||
pos = state.bMarks[next]+state.tShift[next];
|
|
||||||
max = state.eMarks[next];
|
|
||||||
|
|
||||||
if(pos < max && state.tShift[next] < state.blkIndent){
|
|
||||||
// non-empty line with negative indent should stop the list:
|
|
||||||
break;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if(state.src.slice(pos,max).trim().slice(-2)==='$$'){
|
for(next = start; !found; ){
|
||||||
lastPos = state.src.slice(0,max).lastIndexOf('$$');
|
|
||||||
lastLine = state.src.slice(pos,lastPos);
|
next++;
|
||||||
found = true;
|
|
||||||
|
if(next >= end){ break; }
|
||||||
|
|
||||||
|
pos = state.bMarks[next]+state.tShift[next];
|
||||||
|
max = state.eMarks[next];
|
||||||
|
|
||||||
|
if(pos < max && state.tShift[next] < state.blkIndent){
|
||||||
|
// non-empty line with negative indent should stop the list:
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
if(state.src.slice(pos,max).trim().slice(-2)==='$$'){
|
||||||
|
lastPos = state.src.slice(0,max).lastIndexOf('$$');
|
||||||
|
lastLine = state.src.slice(pos,lastPos);
|
||||||
|
found = true;
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
state.line = next + 1;
|
||||||
|
|
||||||
state.line = next + 1;
|
token = state.push('math_block', 'math', 0);
|
||||||
|
token.block = true;
|
||||||
token = state.push('math_block', 'math', 0);
|
token.content = (firstLine && firstLine.trim() ? firstLine + '\n' : '')
|
||||||
token.block = true;
|
|
||||||
token.content = (firstLine && firstLine.trim() ? firstLine + '\n' : '')
|
|
||||||
+ state.getLines(start + 1, next, state.tShift[start], true)
|
+ state.getLines(start + 1, next, state.tShift[start], true)
|
||||||
+ (lastLine && lastLine.trim() ? lastLine : '');
|
+ (lastLine && lastLine.trim() ? lastLine : '');
|
||||||
token.map = [ start, state.line ];
|
token.map = [ start, state.line ];
|
||||||
token.markup = '$$';
|
token.markup = '$$';
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = function math_plugin(md, options) {
|
module.exports = function math_plugin(md, options) {
|
||||||
// Default options
|
// Default options
|
||||||
|
|
||||||
options = options || {};
|
options = options || {};
|
||||||
|
|
||||||
// set KaTeX as the renderer for markdown-it-simplemath
|
// set KaTeX as the renderer for markdown-it-simplemath
|
||||||
var katexInline = function(latex){
|
var katexInline = function(latex){
|
||||||
options.displayMode = false;
|
options.displayMode = false;
|
||||||
try{
|
try{
|
||||||
return katex.renderToString(latex, options);
|
return katex.renderToString(latex, options);
|
||||||
|
}
|
||||||
|
catch(error){
|
||||||
|
if(options.throwOnError){ console.log(error); }
|
||||||
|
return latex;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
var inlineRenderer = function(tokens, idx){
|
||||||
|
return katexInline(tokens[idx].content);
|
||||||
|
};
|
||||||
|
|
||||||
|
var katexBlock = function(latex){
|
||||||
|
options.displayMode = true;
|
||||||
|
try{
|
||||||
|
return "<p>" + katex.renderToString(latex, options) + "</p>";
|
||||||
|
}
|
||||||
|
catch(error){
|
||||||
|
if(options.throwOnError){ console.log(error); }
|
||||||
|
return latex;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
catch(error){
|
|
||||||
if(options.throwOnError){ console.log(error); }
|
var blockRenderer = function(tokens, idx){
|
||||||
return latex;
|
return katexBlock(tokens[idx].content) + '\n';
|
||||||
}
|
}
|
||||||
};
|
|
||||||
|
|
||||||
var inlineRenderer = function(tokens, idx){
|
md.inline.ruler.after('escape', 'math_inline', math_inline);
|
||||||
return katexInline(tokens[idx].content);
|
md.block.ruler.after('blockquote', 'math_block', math_block, {
|
||||||
};
|
alt: [ 'paragraph', 'reference', 'blockquote', 'list' ]
|
||||||
|
});
|
||||||
var katexBlock = function(latex){
|
md.renderer.rules.math_inline = inlineRenderer;
|
||||||
options.displayMode = true;
|
md.renderer.rules.math_block = blockRenderer;
|
||||||
try{
|
|
||||||
return "<p>" + katex.renderToString(latex, options) + "</p>";
|
|
||||||
}
|
|
||||||
catch(error){
|
|
||||||
if(options.throwOnError){ console.log(error); }
|
|
||||||
return latex;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
var blockRenderer = function(tokens, idx){
|
|
||||||
return katexBlock(tokens[idx].content) + '\n';
|
|
||||||
}
|
|
||||||
|
|
||||||
md.inline.ruler.before('escape', 'math_inline', math_inline);
|
|
||||||
md.block.ruler.after('blockquote', 'math_block', math_block, {
|
|
||||||
alt: [ 'paragraph', 'reference', 'blockquote', 'list' ]
|
|
||||||
});
|
|
||||||
md.renderer.rules.math_inline = inlineRenderer;
|
|
||||||
md.renderer.rules.math_block = blockRenderer;
|
|
||||||
};
|
};
|
||||||
|
|
|
||||||
|
|
@ -22,7 +22,7 @@
|
||||||
"author": "waylonflinn@gmail.com",
|
"author": "waylonflinn@gmail.com",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"katex": "^0.5.1"
|
"katex": "^0.6.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"markdown-it": "^6.0.0",
|
"markdown-it": "^6.0.0",
|
||||||
|
|
|
||||||
60
test/fixtures/default.txt
vendored
60
test/fixtures/default.txt
vendored
|
|
@ -35,20 +35,13 @@ aaa $$ bbb
|
||||||
<p>aaa $$ bbb</p>
|
<p>aaa $$ bbb</p>
|
||||||
.
|
.
|
||||||
|
|
||||||
Shouldn't render USD
|
Should require a closing delimiter
|
||||||
.
|
.
|
||||||
aaa $5.99 bbb
|
aaa $5.99 bbb
|
||||||
.
|
.
|
||||||
<p>aaa $5.99 bbb</p>
|
<p>aaa $5.99 bbb</p>
|
||||||
.
|
.
|
||||||
|
|
||||||
Shouldn't render trailing delimiter
|
|
||||||
.
|
|
||||||
aaa 5.99$ bbb
|
|
||||||
.
|
|
||||||
<p>aaa 5.99$ bbb</p>
|
|
||||||
.
|
|
||||||
|
|
||||||
Paragraph break in inline math is not allowed
|
Paragraph break in inline math is not allowed
|
||||||
.
|
.
|
||||||
foo $1+1
|
foo $1+1
|
||||||
|
|
@ -59,14 +52,7 @@ foo $1+1
|
||||||
<p>= 2$ bar</p>
|
<p>= 2$ bar</p>
|
||||||
.
|
.
|
||||||
|
|
||||||
Neither is an end of document
|
Inline math with apparent markup should not be processed
|
||||||
.
|
|
||||||
foo $1+1 = 2
|
|
||||||
.
|
|
||||||
<p>foo $1+1 = 2</p>
|
|
||||||
.
|
|
||||||
|
|
||||||
Inline math with apparent markup
|
|
||||||
.
|
.
|
||||||
foo $1 *i* 1$ bar
|
foo $1 *i* 1$ bar
|
||||||
.
|
.
|
||||||
|
|
@ -193,3 +179,45 @@ $$
|
||||||
1
|
1
|
||||||
$$</p>
|
$$</p>
|
||||||
.
|
.
|
||||||
|
|
||||||
|
Numbers can not follow closing inline math
|
||||||
|
.
|
||||||
|
Thus, $20,000 and USD$30,000 won't parse as math.
|
||||||
|
.
|
||||||
|
<p>Thus, $20,000 and USD$30,000 won't parse as math.</p>
|
||||||
|
.
|
||||||
|
|
||||||
|
Require non whitespace to right of opening inline math
|
||||||
|
.
|
||||||
|
For some Europeans, it is 2$ for a can of soda, not 1$.
|
||||||
|
.
|
||||||
|
<p>For some Europeans, it is 2$ for a can of soda, not 1$.</p>
|
||||||
|
.
|
||||||
|
|
||||||
|
Require non whitespace to left of closing inline math.
|
||||||
|
.
|
||||||
|
I will give you $20 today, if you give me more $ tomorrow.
|
||||||
|
.
|
||||||
|
<p>I will give you $20 today, if you give me more $ tomorrow.</p>
|
||||||
|
.
|
||||||
|
|
||||||
|
Inline blockmath is not (currently) registered.
|
||||||
|
.
|
||||||
|
It's well know that $$1 + 1 = 3$$ for sufficiently large 1.
|
||||||
|
.
|
||||||
|
<p>It's well know that $$1 + 1 = 3$$ for sufficiently large 1.</p>
|
||||||
|
.
|
||||||
|
|
||||||
|
Escaped delimiters in math mode
|
||||||
|
.
|
||||||
|
Money adds: $\$X + \$Y = \$Z$.
|
||||||
|
.
|
||||||
|
<p>Money adds: <span class="katex"><span class="katex-mathml"><math><semantics><mrow><mi mathvariant="normal">$</mi><mi>X</mi><mo>+</mo><mi mathvariant="normal">$</mi><mi>Y</mi><mo>=</mo><mi mathvariant="normal">$</mi><mi>Z</mi></mrow><annotation encoding="application/x-tex">\$X + \$Y = \$Z</annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="strut" style="height:0.75em;"></span><span class="strut bottom" style="height:0.83333em;vertical-align:-0.08333em;"></span><span class="base textstyle uncramped"><span class="mord mathrm">$</span><span class="mord mathit" style="margin-right:0.07847em;">X</span><span class="mbin">+</span><span class="mord mathrm">$</span><span class="mord mathit" style="margin-right:0.22222em;">Y</span><span class="mrel">=</span><span class="mord mathrm">$</span><span class="mord mathit" style="margin-right:0.07153em;">Z</span></span></span></span>.</p>
|
||||||
|
.
|
||||||
|
|
||||||
|
Multiple escaped delimiters in math module
|
||||||
|
.
|
||||||
|
Weird-o: $\displaystyle{\begin{pmatrix} \$ & 1\\\$ \end{pmatrix}}$.
|
||||||
|
.
|
||||||
|
<p>Weird-o: <span class="katex"><span class="katex-mathml"><math><semantics><mrow><mstyle scriptlevel="0" displaystyle="true"><mrow><mrow><mo fence="true">(</mo><mtable><mtr><mtd><mrow><mi mathvariant="normal">$</mi></mrow></mtd><mtd><mrow><mn>1</mn></mrow></mtd></mtr><mtr><mtd><mrow><mi mathvariant="normal">$</mi></mrow></mtd></mtr></mtable><mo fence="true">)</mo></mrow></mrow></mstyle></mrow><annotation encoding="application/x-tex">\displaystyle{\begin{pmatrix} \$ & 1\\\$ \end{pmatrix}}</annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="strut" style="height:1.45em;"></span><span class="strut bottom" style="height:2.40003em;vertical-align:-0.95003em;"></span><span class="base textstyle uncramped"><span class="reset-textstyle displaystyle textstyle uncramped"><span class="mord displaystyle textstyle uncramped"><span class="minner displaystyle textstyle uncramped"><span class="style-wrap reset-textstyle textstyle uncramped" style="top:0em;"><span class="delimsizing size3">(</span></span><span class="mord"><span class="mtable"><span class="col-align-c"><span class="vlist"><span style="top:-0.6099999999999999em;"><span class="fontsize-ensurer reset-size5 size5"><span style="font-size:0em;"></span></span><span class="mord displaystyle textstyle uncramped"><span class="mord mathrm">$</span></span></span><span style="top:0.5900000000000003em;"><span class="fontsize-ensurer reset-size5 size5"><span style="font-size:0em;"></span></span><span class="mord displaystyle textstyle uncramped"><span class="mord mathrm">$</span></span></span><span class="baseline-fix"><span class="fontsize-ensurer reset-size5 size5"><span style="font-size:0em;"></span></span></span></span></span><span class="arraycolsep" style="width:0.5em;"></span><span class="arraycolsep" style="width:0.5em;"></span><span class="col-align-c"><span class="vlist"><span style="top:-0.6099999999999999em;"><span class="fontsize-ensurer reset-size5 size5"><span style="font-size:0em;"></span></span><span class="mord displaystyle textstyle uncramped"><span class="mord mathrm">1</span></span></span><span class="baseline-fix"><span class="fontsize-ensurer reset-size5 size5"><span style="font-size:0em;"></span></span></span></span></span></span></span><span class="style-wrap reset-textstyle textstyle uncramped" style="top:0em;"><span class="delimsizing size3">)</span></span></span></span></span></span></span></span>.</p>
|
||||||
|
.
|
||||||
|
|
|
||||||
Reference in a new issue