plugin-katex

Gungnir
2021-12-12
3 min

npmgithublicense

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

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

安装

pnpm install @renovamen/vuepress-plugin-katex@next
yarn add @renovamen/vuepress-plugin-katex@next
npm install @renovamen/vuepress-plugin-katex@next

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

const { katexPlugin } = require("@renovamen/vuepress-plugin-katex");

module.exports = {
  plugins: [
    katexPlugin()
  ]
}

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

const { katexPlugin } = require("@renovamen/vuepress-plugin-katex");

module.exports = {
  plugins: [
    katexPlugin({
      "throwOnError": false,
      "errorColor": "#cc0000"
    })
  ]
}

使用

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

例子:

行内公式:

行块公式:

代码
行内公式:$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