Version 0.7.0

goessner · goessner · commit 9e1c5b922a3c · 2020-06-14T11:12:12.000+02:00
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "markdown-it-texmath",
-  "version": "0.6.9",
+  "version": "0.7.0",
   "description": "markdown-it extension for rendering TeX Math",
   "keywords": [
     "TeX",
diff --git a/readme.md b/readme.md
@@ -16,7 +16,7 @@ This extension is a comfortable tool for scientists, engineers and students with
 * Inline math with tables, lists and blockquote.
 * User setting delimiters:
   * `'dollars'` (default)
-    * inline: `$...$`
+    * inline: `$...$` or `$$...$$`
     * display: `$$...$$`
     * display + equation number: `$$...$$ (1)`
   * `'brackets'`
@@ -35,10 +35,6 @@ This extension is a comfortable tool for scientists, engineers and students with
     * inline: ``$$...$$``
     * display: `$$...$$`
     * display + equation number: `$$...$$ (1)`
-  * `'pandoc'`
-    * inline: `$...$`  or `$$...$$`
-    * display: `$$...$$`
-    * display + equation number: `$$...$$ (1)`
 
 ## Show me 
 
@@ -107,7 +103,11 @@ Use following links for `texmath.js` and `texmath.css`
 
 ## FAQ
 
-* Display math inside of `blockquote` blocks is able to span multiple lines with version "0.6.8". Every single display math line **must** begin with a `>` character then, as in 
+* __Support of inline syntax of display math ?__   
+  * Inline syntax of display math with `dollars` mode is supported starting from version "0.7.0". So `'This formula $$a+b=c$$ will result in display math presentation'`, i.e. gets displayed on a separate line. For *true* inline math use `$..$` mode like before.
+
+* __Multiline diplay math in `blockquote` block possible ?__   
+  * Display math inside of `blockquote` blocks is able to span multiple lines with version "0.6.8". Every single display math line **must** begin with a `>` character then, as in 
 ```
 > $$ a +     
 >     b 
@@ -118,13 +118,19 @@ Use following links for `texmath.js` and `texmath.css`
 * __`markdown-it-texmath` with React Native does not work, why ?__
   * `markdown-it-texmath` is using regular expressions with `y` [(sticky) property](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/sticky) and cannot avoid this. The use of the `y` flag in regular expressions means the plugin is not compatible with React Native (which as of now doesn't support it and throws an error `Invalid flags supplied to RegExp constructor`).
 
-* __Why doesn't `markdown-it-texmath` work with mathjax ?__
-  * `markdown-it-texmath` is a personal project of mine. As it does very well what I want it to do, I offer it to the public as an open source plugin. I do not have time or interest to integrate other math engines.
+* __Why doesn't `markdown-it-texmath` work with other engines ?__
+  * `markdown-it-texmath` is a personal project of mine. As it does very well with KaTeX what I want it to do, I offer it to the public as an open source plugin. I do not have time or interest to integrate other math engines.
   But if someone wants to help here out, pull requests are always welcome.
 
 
 ## CHANGELOG
 
+###  [0.7.0] on June 14, 2020
+* Experimental `pandoc` mode removed. Enhanced `dollars` mode now does, what `pandoc` mode was requiring.
+* With `dollars` mode inline math expression `$$..$$` will result in display math presentation now. Adding equation numbers `$$..$$(1)` is not supported in inline syntax.
+* Significant code redesign and regular expression optimization results in more compact code and performance gain ... not measured though.
+* Bug with display math inside of `blockquote` blocks removed.
+
 ###  [0.6.9] on June 11, 2020
 * Now display math inside of `blockquote` blocks can span multiple lines, provided that every line starts with a `>` character.
 * Possible cause of [blockquote bug(https://github.com/goessner/mdmath/issues/50)] presumably eliminated.
diff --git a/test/blockquote-bug.html b/test/blockquote-bug.html
@@ -0,0 +1,38 @@
+<!doctype html>
+<html>
+<head>
+  <meta charset='utf-8'>
+  <link  rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex/dist/katex.min.css">
+  <link rel="stylesheet" href="../css/texmath.css">
+  <style>blockquote { background-color:#eee;} </style>
+  <script src="https://cdn.jsdelivr.net/npm/markdown-it/dist/markdown-it.min.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/katex/dist/katex.min.js"></script>
+  <script src="../texmath.js"></script>
+</head>
+<body>
+  <div id="out"></div>
+  <script>
+    const str = `
+> *Hi*
+> > He $5 +\\pi$
+> >
+> > $$c^2 = 
+> > a^2 + \\phi
+> > \\sqrt{b^2}$$ (2)
+>
+> ahsgahg
+
+Ho xyz $$\\psi+\\phi$$ abcdef ashagsh
+
+abcdefghi
+
+$$a + b = \\pi$$ (3)
+x
+`
+    document.addEventListener("DOMContentLoaded", () => {
+        const md = markdownit().use(texmath, {engine:katex, delimiters:'dollars',macros:{"\\RR": "\\mathbb{R}"}});
+        out.innerHTML = md.render(str);
+    })
+  </script>
+</body>
+</html>
diff --git a/test/blockquote-bug.js b/test/blockquote-bug.js
@@ -2,13 +2,13 @@
 
 const tm = require('../texmath.js');
 //const md = require('markdown-it')({html:true}).use(tm,{engine:require('katex'), delimiters:'dollars'});
-const md = require('markdown-it')({html:true}).use(tm,{engine:require('katex'), delimiters:'gitlab'});
+const md = require('markdown-it')({html:true}).use(tm,{engine:require('katex'), delimiters:'dollars'});
 const str = `
 With 
 
-> \`\`\`math 
+> $$
 >  x 
->  \`\`\`
+> $$
 `;
 
 // overwrite texmath render function (suppressing katex)
diff --git a/test/bugtest.html b/test/bugtest.html
@@ -26,9 +26,20 @@
 
 with
 
-$$
-{\\bold e}_\\alpha = \\begin{pmatrix}\\cos\\alpha\\\\ \\sin\\alpha\\end{pmatrix} \\quad and \\quad {\\tilde\\bold e}_\\alpha = \\begin{pmatrix}-\\sin\\alpha\\\\ \\cos\\alpha\\end{pmatrix}
-$$
+> hello    
+> world
+
+> $$c^2 = 
+> a^2 + 
+> b^2$$ (2)
+
+
+> 
+>$$
+>{\\bold e}_\\alpha = \\begin{pmatrix}\\cos\\alpha\\\\ \\sin\\alpha\\end{pmatrix} \\quad and 
+>\\quad {\\tilde\\bold e}_\\alpha = \\begin{pmatrix}-\\sin\\alpha\\\\ \\cos\\alpha\\end{pmatrix}
+> $$
+>
 
 Resolving for the hypothenuse part $c{\\bold e}_x$ and $c{\\bold e}_\\varphi$ as well as $u$ in the loop closure equation (1) 
 
@@ -41,7 +52,7 @@
 finally results in the Pythagorean theorem (2)
 
 $$
-c^2 = a^2 + b^2 
+c^2 = a^2 + b^2 + \pi
 $$ (3)
 `
     document.addEventListener("DOMContentLoaded", () => {
diff --git a/test/pandoc-bug.html b/test/pandoc-bug.html
@@ -19,7 +19,6 @@
     str = `# Triangle
 Let the right triangle hypothenuse be aligned with the coordinate system *x-axis*.
 The vector loop closure equation then reads
-
 $$
 a{\\bold e}_\\alpha + b\\tilde{\\bold e}_\\alpha + c{\\bold e}_x = \\bold 0
 $$ (1)
@@ -45,7 +44,7 @@
 $$ (3)
 `
     document.addEventListener("DOMContentLoaded", () => {
-        md = markdownit().use(texmath, {engine:katex, delimiters:'pandoc',macros:{"\\RR": "\\mathbb{R}"}});
+        md = markdownit().use(texmath, {engine:katex, delimiters:'dollars',macros:{"\\RR": "\\mathbb{R}"}});
         out.innerHTML = md.render(str);
     })
   </script>
diff --git a/texmath.js b/texmath.js
@@ -22,7 +22,7 @@ function texmath(md, options) {
     if (delimiters in texmath.rules) {
         for (const rule of texmath.rules[delimiters].inline) {
             md.inline.ruler.before('escape', rule.name, texmath.inline(rule));  // ! important
-            md.renderer.rules[rule.name] = (tokens, idx) => rule.tmpl.replace(/\$1/,texmath.render(tokens[idx].content,false,katexOptions));
+            md.renderer.rules[rule.name] = (tokens, idx) => rule.tmpl.replace(/\$1/,texmath.render(tokens[idx].content,!!rule.displayMode,katexOptions));
         }
 
         for (const rule of texmath.rules[delimiters].block) {
@@ -33,60 +33,69 @@ function texmath(md, options) {
     }
 }
 
-texmath.applyRule = function(rule, str, beg, inBlockquote) {
-    let pre, match, post;
-    rule.rex.lastIndex = beg;
-
-    pre = str.startsWith(rule.tag,beg) && (!rule.pre || rule.pre(str,beg)); // pre-condition ...
-    match = pre && rule.rex.exec(str);
-    if (match) {
-        match.lastIndex = rule.rex.lastIndex;
-        post = (!rule.post || rule.post(str, match.lastIndex-1))  // valid post-condition ...
-            && (!inBlockquote || !match[1].includes('\n') || !/\n[^>]/gm.test(match[1]));  // not in blockquote || on single line || every bol == '>' 
-        if (post && inBlockquote)
-           match[1] = match[1].replace(/\n>/gm,'\n');  // remove '>' at bol inside of display math !
-    }
-    rule.rex.lastIndex = 0;
-
-    return post && match;  // returning match object ... !
-}
-
 // texmath.inline = (rule) => dollar;  // just for testing ..
 
 texmath.inline = (rule) => 
     function(state, silent) {
-        const res = texmath.applyRule(rule, state.src, state.pos);
-        if (res) {
+        const pos = state.pos;
+        const str = state.src;
+        const pre = str.startsWith(rule.tag, rule.rex.lastIndex = pos) && (!rule.pre || rule.pre(str, pos));  // valid pre-condition ...
+        const match = pre && rule.rex.exec(str);
+        const lastPos = match && (rule.rex.lastIndex - 1);
+
+        if (match && (!rule.post || rule.post(str, lastPos))) {   // match && valid post-condition
             if (!silent) {
                 const token = state.push(rule.name, 'math', 0);
-                token.content = res[1];  // group 1 from regex ..
+                token.content = match[1];
                 token.markup = rule.tag;
             }
-            state.pos = res.lastIndex;
+            state.pos = rule.rex.lastIndex;
         }
-        return !!res;
+        rule.rex.lastIndex = 0;
+        return !!match;
     }
 
 texmath.block = (rule) => 
-    function(state, begLine, endLine, silent) {
-        const res = texmath.applyRule(rule, state.src, state.bMarks[begLine] + state.tShift[begLine], state.parentType==='blockquote');
-        if (res) {
+    function block(state, begLine, endLine, silent) {
+        texmath.inBlockquote(state.tokens);  // cache current blockquote level ...
+
+        const pos = state.bMarks[begLine] + state.tShift[begLine];
+        const str = state.src;
+        const pre = str.startsWith(rule.tag, rule.rex.lastIndex = pos) && (!rule.pre || rule.pre(str, pos));  // valid pre-condition ....
+        const match = pre && rule.rex.exec(str);
+        const lastPos = match && (rule.rex.lastIndex - 1);
+
+        if (match && (!rule.post || rule.post(str, lastPos))) {    // match and valid post-condition ...
+            if (match[1].includes('\n') && texmath.inBlockquote.level) // multiline display math inside of blockquote block.
+                match[1] = match[1].replace(/\n(\s*?>)+/gm,'\n');  // remove all leading '>' inside of display math !
             if (!silent) {
                 const token = state.push(rule.name, 'math', 0);
                 token.block = true;
-                token.content = res[1];
-                token.info = res[res.length-1];
+                token.content = match[1];
+                token.info = match[match.length-1];
                 token.markup = rule.tag;
             }
-            for (let line=begLine, endpos=res.lastIndex-1; line < endLine; line++)
+            for (let line=begLine, endpos=lastPos; line < endLine; line++)
                 if (endpos >= state.bMarks[line] && endpos <= state.eMarks[line]) { // line for end of block math found ...
                     state.line = line+1;
                     break;
                 }
-            state.pos = res.lastIndex;
         }
-        return !!res;
+        rule.rex.lastIndex = 0;
+        return !!match;
+    }
+
+texmath.inBlockquote = function(tokens) {
+    if (tokens && tokens.length) {
+        const len = tokens.length;
+        texmath.inBlockquote.level = tokens[len-1].type === 'blockquote_open'  ? tokens[len-1].level + 1
+                                   : tokens[len-1].type === 'blockquote_close' ? tokens[len-1].level
+                                   : texmath.inBlockquote.level;
     }
+    else
+        texmath.inBlockquote.level = 0;
+}
+texmath.inBlockquote.level = 0;
 
 texmath.render = function(tex,displayMode,options) {
     options.displayMode = displayMode;
@@ -208,15 +217,8 @@ texmath.rules = {
                 tmpl: '<eq>$1</eq>',
                 tag: '``'
             },
-            {   name: 'math_inline', 
-                rex: /\$(\S[^$\r\n]*?[^\s\\]{1}?)\$/gy,
-                tmpl: '<eq>$1</eq>',
-                tag: '$',
-                pre: texmath.$_pre,
-                post: texmath.$_post
-            },
-            {   name: 'math_single',
-                rex: /\$([^$\s\\]{1}?)\$/gy,
+            {   name: 'math_inline',
+                rex: /\$((?:\S?)|(?:\S.*?\S))\$/gy,
                 tmpl: '<eq>$1</eq>',
                 tag: '$',
                 pre: texmath.$_pre,
@@ -239,56 +241,36 @@ texmath.rules = {
     kramdown: {
         inline: [ 
             {   name: 'math_inline', 
-                rex: /\${2}([^$\r\n]*?)\${2}/gy,
+                rex: /\${2}(.+?)\${2}/gy,
                 tmpl: '<eq>$1</eq>',
                 tag: '$$'
             }
         ],
         block: [
             {   name: 'math_block_eqno',
-                rex: /\${2}([^$]*?)\${2}\s*?\(([^)$\r\n]+?)\)/gmy,
-                tmpl: '<section class="eqno"><eqn>$1</eqn><span>($2)</span></section>',
-                tag: '$$'
-            },
-            {   name: 'math_block',
-                rex: /\${2}([^$]*?)\${2}/gmy,
-                tmpl: '<section><eqn>$1</eqn></section>',
-                tag: '$$'
-            }
-        ]
-    },
-    pandoc: {
-        inline: [ 
-            {   name: 'math_block', 
-                rex: /\${2}([^$]*?)\${2}/gy,
-                tmpl: '<section><eqn>$1</eqn></section>',
-                tag: '$$'
-            }
-        ],
-        block: [
-            {   name: 'math_block_eqno',
-                rex: /\${2}([^$]*?)\${2}\s*?\(([^)$\r\n]+?)\)/gmy,
+                rex: /\${2}([^$]+?)\${2}\s*?\(([^)\s]+?)\)/gmy,
                 tmpl: '<section class="eqno"><eqn>$1</eqn><span>($2)</span></section>',
                 tag: '$$'
             },
             {   name: 'math_block',
-                rex: /\${2}([^$]*?)\${2}/gmy,
+                rex: /\${2}([^$]+?)\${2}/gmy,
                 tmpl: '<section><eqn>$1</eqn></section>',
                 tag: '$$'
             }
         ]
     },
     dollars: {
-        inline: [ 
-            {   name: 'math_inline', 
-                rex: /\$(\S[^$\r\n]*?[^\s\\]{1}?)\$/gy,
-                tmpl: '<eq>$1</eq>',
-                tag: '$',
+        inline: [
+            {   name: 'math_inline_double',
+                rex: /\${2}((?:\S)|(?:\S.*?\S))\${2}/gy,
+                tmpl: '<section><eqn>$1</eqn></section>',
+                tag: '$$',
+                displayMode: true,
                 pre: texmath.$_pre,
                 post: texmath.$_post
             },
-            {   name: 'math_single',
-                rex: /\$([^$\s\\]{1}?)\$/gy,
+            {   name: 'math_inline',
+                rex: /\$((?:\S)|(?:\S.*?\S))\$/gy,
                 tmpl: '<eq>$1</eq>',
                 tag: '$',
                 pre: texmath.$_pre,
@@ -297,12 +279,12 @@ texmath.rules = {
         ],
         block: [
             {   name: 'math_block_eqno',
-                rex: /\${2}([^$]*?)\${2}\s*?\(([^)$\r\n]+?)\)/gmy,
+                rex: /\${2}([^$]+?)\${2}\s*?\(([^)\s]+?)\)/gmy,
                 tmpl: '<section class="eqno"><eqn>$1</eqn><span>($2)</span></section>',
                 tag: '$$'
             },
             {   name: 'math_block',
-                rex: /\${2}([^$]*?)\${2}/gmy,
+                rex: /\${2}([^$]+?)\${2}/gmy,
                 tmpl: '<section><eqn>$1</eqn></section>',
                 tag: '$$'
             }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "markdown-it-texmath",`
`3`		`- "version": "0.6.9",`
	`3`	`+ "version": "0.7.0",`
`4`	`4`	`"description": "markdown-it extension for rendering TeX Math",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"TeX",`