plugin-katex

Gungnir
2020-03-26
3 min

npm github license

@renovamen/vuepress-plugin-katex 插件,用于在 VuePress 的 Markdown 中使用 KaTeX,从而在文章中支持数学公式渲染。该插件基于 waylonflinn/markdown-it-katex

KaTeX 是一种比 MathJax 更快的公式渲染引擎(速度比较可以参考这里)。

# 安装

yarn add @renovamen/vuepress-plugin-katex
# or
npm install @renovamen/vuepress-plugin-katex

然后在 .vuepress/config.js 中引入这个插件:

module.exports = {
  plugins: [
    [
      '@renovamen/vuepress-plugin-katex'
    ]
  ]
}

也可以传入一些 KaTeX 的配置项,如:

module.exports = {
  plugins: [
    [
      '@renovamen/vuepress-plugin-katex', {
        'throwOnError': false,
        'errorColor': '#cc0000'
      }
    ]
  ]
}

# 使用

这里是所有 KaTex 支持的公式列表。

例子:

行内公式:E=mc2E = mc^2

行块公式:

iψt=22m(2x2+2y2+2z2)ψ+Vψ.i\hbar\frac{\partial \psi}{\partial t} = \frac{-\hbar^2}{2m} ( \frac{\partial^2}{\partial x^2} + \frac{\partial^2}{\partial y^2} + \frac{\partial^2}{\partial z^2} ) \psi + V \psi.

代码
行内公式:$E = mc^2$

行块公式:

$$
i\hbar\frac{\partial \psi}{\partial t} = \frac{-\hbar^2}{2m} ( \frac{\partial^2}{\partial x^2} + \frac{\partial^2}{\partial y^2} + \frac{\partial^2}{\partial z^2} ) \psi + V \psi.
$$

# 开源协议

MIT