Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

markdown-it-texmath

0.7.2 • Public • Published

License npm npm

markdown-it-texmath

Add TeX math equations to your Markdown documents rendered by markdown-it parser. KaTeX is used as a fast math renderer.

Features

Simplify the process of authoring markdown documents containing math formulas. This extension is a comfortable tool for scientists, engineers and students with markdown as their first choice document format.

  • Macro support
  • Simple formula numbering
  • Inline math with tables, lists and blockquote.
  • User setting delimiters:
    • 'dollars' (default)
      • inline: $...$ or $$...$$
      • display: $$...$$
      • display + equation number: $$...$$ (1)
    • 'brackets'
      • inline: \(...\)
      • display: \[...\]
      • display + equation number: \[...\] (1)
    • 'gitlab'
      • inline: $`...`$
      • display: ```math ... ```
      • display + equation number: ```math ... ``` (1)
    • 'julia'
      • inline: $...$ or ``...``
      • display: ```math ... ```
      • display + equation number: ```math ... ``` (1)
    • 'kramdown'
      • inline: $$...$$
      • display: $$...$$
      • display + equation number: $$...$$ (1)

Show me

View a test table.

try it out ...

Use with node.js

Install the extension. Verify having markdown-it and katex already installed .

npm install markdown-it-texmath

Use it with JavaScript.

    tm = require('markdown-it-texmath'),
    md = require('markdown-it')().use(tm, { engine: require('katex'),
                                            delimiters:'dollars',
                                            katexOptions: { macros: {"\\RR": "\\mathbb{R}"} }
                                          });
 
md.render('Euler\'s identity \(e^{i\pi}+1=0\) is a beautiful formula in $\\RR 2$.')

Use in Browser

<html>
<head>
  <meta charset='utf-8'>
  <link  rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex/dist/katex.min.css">
  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/markdown-it-texmath/css/texmath.min.css">
  <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="https://cdn.jsdelivr.net/npm/markdown-it-texmath/texmath.min.js"></script> 
</head>
<body>
  <div id="out"></div>
  <script>
    document.addEventListener("DOMContentLoaded", () => {
        const tm = texmath.use(katex);
        const md = markdownit().use(tm, { engine: katex,
                                          delimiters:'dollars',
                                          katexOptions: { macros: {"\\RR": "\\mathbb{R}"} }
                                        });
        document.getElementById('out').innerHTML = 
            md.render('Euler\'s identity $e^{i\pi}+1=0$ is a beautiful formula in //RR 2.');
    })
  </script> 
</body>
</html>

CDN

Use following links for texmath.js and texmath.css

  • https://cdn.jsdelivr.net/npm/markdown-it-texmath/texmath.min.js
  • https://cdn.jsdelivr.net/npm/markdown-it-texmath/css/texmath.min.css

Dependencies

  • markdown-it: Markdown parser done right. Fast and easy to extend.
  • katex: This is where credits for fast rendering TeX math in HTML go to.

ToDo

nothing yet

FAQ

  • 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 
> = c
> $$
  • markdown-it-texmath with React Native does not work, why ?

    • markdown-it-texmath is using regular expressions with y (sticky) property 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 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.2] on June 22, 2020

  • Regex bug with gitlab mode removed.

[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.
  • Update to markdown-it version 11.0.0

[0.6.7] on April 29, 2020

[0.6.6] on April 07, 2020

  • Removed a small bug in activation method.

[0.6.5] on April 05, 2020

  • Hand instance of katex over to markdown-it-texmath using options.engine object. Works with node.js and browsers. With node.js options.engine entry { engine:'katex' } as a string also works.
  • As a consequence of the topic before, the use method of markdown-it-texmath is deprecated now.
  • Add beta support for Pandoc syntax on request. Here waiting for test results.
  • Using jsdelivr as cdn from now on.

[0.6.0] on October 04, 2019

[0.5.5] on February 07, 2019

[0.5.4] on January 20, 2019

[0.5.3] on November 11, 2018

  • Add support for Tex macros (https://katex.org/docs/supported.html#macros) .
  • Bug with brackets delimiters .

[0.5.2] on September 07, 2018

[0.5.0] on August 15, 2018

  • Fatal blockquote bug investigated. Implemented workaround to vscode bug, which has finally gone with vscode 1.26.0 .

[0.4.6] on January 05, 2018

  • Escaped underscore bug removed.

[0.4.5] on November 06, 2017

  • Backslash bug removed.

[0.4.4] on September 27, 2017

  • Modifying the block mode regular expression with gitlab delimiters, so removing the newline bug.

License

markdown-it-texmath is licensed under the MIT License

© Stefan Gössner

Install

npm i markdown-it-texmath

DownloadsWeekly Downloads

922

Version

0.7.2

License

MIT

Unpacked Size

102 kB

Total Files

15

Last publish

Collaborators

  • avatar