markdown-math
在你的 Markdown 添加数学支持。
此插件允许你使用 mathjax
或 katex
在 Markdown 中渲染 内容。
使用方法
npm i -D @vuepress/plugin-markdown-math@next
# 安装下列包之一:
npm i -D mathjax-full
npm i -D katex
import { markdownMathPlugin } from '@vuepress/plugin-markdown-math'
export default {
plugins: [
markdownMathPlugin({
// 选项
}),
],
}
格式
内联模式:
$xxx$
::: preview
Euler's identity is a beautiful formula in .
:::
显示模式:
$$xxx$$ $$ xxx $$
::: preview
:::
转义
可以通过在 $
字符之前使用 \
或在 $
字符前后添加空格来完成转义:
::: preview
是一个 TeX 方程,而 $ a=1 $ 和 $a=1$ 不是。
:::
支持列表
TeX 教程:
插件教程和常见问题: TeX
Katex:
Mathjax:
配置项
type
类型:
'katex' | 'mathjax'
详情:
用于渲染 内容的包。
当未指定此选项时,插件将尝试检测安装了哪个包。如果两者都安装了,它将使用“mathjax”。
delimiters
类型:
'brackets' | 'dollars' | 'all'
默认值:
'dollars'
详情:启用的数学分隔符语法。
"brackets"
: 使用\(...\)
表示内联数学,使用\[...\]
表示显示模式数学(LaTeX 风格)"dollars"
: 使用$...$
表示内联数学,使用$$...$$
表示显示模式数学(常见 Markdown 风格)"all"
: 启用括号和美元符号两种语法
使用 KaTeX
使用 KaTeX 时,任何其他选项都将作为 KatexOptions
传递给 KaTeX。有关所有可用选项,请参阅 KaTeX 文档。
此外,还支持 2 个特殊选项:
copy
- 类型:
boolean
- 详情:是否启用复制扩展。
mhchem
- 类型:
boolean
- 详情:是否启用 mhchem 扩展。
使用 MathJax
使用 MathJax 时,你可以设置:
tex
- 类型:
object
- 详情:传递给 TeX 输入解析器的选项。
output
- 类型:
'svg' | 'chtml'
- 默认值:
'svg'
- 详情:输出格式,SVG 或通用 HTML。
chtml
- 类型:
object
- 详情:传递给通用 HTML 输出解析器的选项。
svg
- 类型:
object
- 详情:传递给 SVG 输出解析器的选项。