markdown-math

$@vuepress/plugin-markdown-math$

Add math support to your VuePress site.

This plugin allows you to use mathjax or katex to render $\TeX$ in your markdown content.

Usage

npm i -D @vuepress/plugin-markdown-math@next

# install one of the following packages:
npm i -D @mathjax/src
npm i -D katex

.vuepress/config.ts
import { markdownMathPlugin } from '@vuepress/plugin-markdown-math'

export default {
  plugins: [
    markdownMathPlugin({
      // options
    }),
  ],
}

Syntax

Inline mode: $xxx$
Euler's identity $e^{i\pi}+1=0$ is a beautiful formula in $\mathbb{R}^2$ .
Demo
Euler's identity $e^{i\pi}+1=0$ is a beautiful formula in $\mathbb{R}^2$.
Display mode:
```
$$xxx$$

$$
xxx
$$
```
$\frac {\partial^r} {\partial \omega^r} \left(\frac {y^{\omega}} {\omega}\right) = \left(\frac {y^{\omega}} {\omega}\right) \left\{(\log y)^r + \sum_{i=1}^r \frac {(-1)^ Ir \cdots (r-i+1) (\log y)^{ri}} {\omega^i} \right\}$
Demo
$$ \frac {\partial^r} {\partial \omega^r} \left(\frac {y^{\omega}} {\omega}\right) = \left(\frac {y^{\omega}} {\omega}\right) \left\{(\log y)^r + \sum_{i=1}^r \frac {(-1)^ Ir \cdots (r-i+1) (\log y)^{ri}} {\omega^i} \right\} $$

Escaping

Escaping can be done by using \ before the $ character, or adding space both before and after the $ character.

The $a=1$ is a TeX equation, while $ a=1 $ and $a=1$ is not.

Demo

The $a=1$ is a TeX equation, while $ a=1 $ and \$a=1$ is not.

Support List

TeX Tutorial:

Plugin tutorial and FAQs: TeX

Katex:

Mathjax:

Supported TeX/LaTeX commands

Options

type'katex' | 'mathjax'

The package to render $\TeX$ contents.

'katex': use KaTeX
'mathjax': use MathJax

When this option is not specified, the plugin will try to detect which package is installed. If both are installed, it will use "mathjax".

delimiters'brackets' | 'dollars' | 'all'

Default'dollars'

Math delimiter syntax to enable.

'brackets': Use $...$ for inline math and \[...\] for display math (LaTeX style).
'dollars': Use $...$ for inline math and $$...$$ for display math (common Markdown style).
'all': Enable both bracket and dollar syntaxes.

Using KaTeX

When using KaTeX, any other options will be passed to KaTeX as KatexOptions. See KaTeX Docs for all available options.

Besides, 2 special options are supported:

copyboolean

Whether to enable copy extension.

mhchemboolean

Whether to enable mhchem extension.

Using MathJax

When using MathJax, you can set:

texobject

Options passed to TeX input parser.

output'svg' | 'chtml'

Default'svg'

Output format, either SVG or Common HTML.

chtmlobject

Options passed to Common HTML output parser.

svgobject

Options passed to SVG output parser.