vuepress-plugin-katex

Katex plugin for VuePress

Installation

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

Usage

config

module.exports = {
    // ...
    plugins: {
        '@maginapp/katex': {
          delimiters: 'dollars'
        }
    },
    // or
    plugins: {
        '@maginapp/vuepress-plugin-katex': {
          delimiters: 'dollars'
        }
    },
    // ...
}

// or

module.exports = [
    ['@maginapp/vuepress-plugin-katex', { delimiters: 'dollars' }],
    // or
    ['@maginapp/katex', { delimiters: 'dollars' }],
]

options

delimiters

• type: string
• default: dollars

User setting delimiters, show more

dollars example

You can use render latex mathematical expressions KaTeX:

Gamma公式展示 $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$ 是通过欧拉积分

• inline

$\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt,.$

$\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$

• display

$$ \Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt,. $$

$$
\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.
$$

vue components

• Eq.vue: using for inline

• Eqn.vue: using for block

Projects Using @maginapp/vuepress-plugin-katex

• katex
• markdown-it-texmath

records

• v1.0.5 init version / 初始版本
• v1.0.6 add component:Eq,Eqn / 添加 Eq Eqn 初始组件
• v1.0.7 fix: Eqn dispaly center / 修复display + equation number 模式下Eqn组件不居中问题
• v1.0.8 fix: Vue automatically removes spaces from templates / 修复vue自动去除模板中空格问题
• v1.0.9 style: add custom.css / 添加自定义样式文件
• v1.0.10 fix: delete globalUIComponents / 修复globalUIComponents 导致的底部样式问题
• v1.0.11 fix: modify README usage / 修复 README 示例错误