VuePress 生态系统VuePress 生态系统
  • 主题指南
  • 默认主题
  • Hope 主题
  • Plume 主题
  • Reco 主题
  • 功能插件
  • Markdown 插件
  • 搜索插件
  • 博客插件
  • 渐进式应用插件
  • 统计分析插件
  • 搜索引擎优化插件
  • 开发插件
  • 工具插件
  • AI 插件
  • @vuepress/helper
  • English
  • 简体中文
GitHub
  • 主题指南
  • 默认主题
  • Hope 主题
  • Plume 主题
  • Reco 主题
  • 功能插件
  • Markdown 插件
  • 搜索插件
  • 博客插件
  • 渐进式应用插件
  • 统计分析插件
  • 搜索引擎优化插件
  • 开发插件
  • 工具插件
  • AI 插件
  • @vuepress/helper
  • English
  • 简体中文
GitHub
  • append-date
  • markdown-chart
    • markdown-chart
    • Chart.js
    • ECharts
    • Flowchart
    • Markmap
    • Mermaid
    • PlantUML
  • markdown-container
  • markdown-ext
  • markdown-image
  • markdown-include
  • markdown-hint
  • markdown-math
  • markdown-preview
  • markdown-stylize
  • markdown-tab
  • links-check
  • prismjs
  • revealjs
    • revealjs
    • 幻灯片演示
    • 幻灯片主题
  • shiki

markdown-math

@vuepress/plugin-markdown-math

在你的 Markdown 添加数学支持。

此插件允许你使用 mathjax 或 katex 在 Markdown 中渲染 TeX\TeXTE​X 内容。

使用方法

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

# 安装下列包之一:
npm i -D mathjax-full
npm i -D katex
.vuepress/config.ts
import { markdownMathPlugin } from '@vuepress/plugin-markdown-math'

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

格式

  • 内联模式:$xxx$

    ::: preview

    Euler's identity eiπ+1=0e^{i\pi}+1=0eiπ+1=0 is a beautiful formula in R2\mathbb{R}^2R2.

    :::

  • 显示模式:

    $$xxx$$
    
    $$
    xxx
    $$

    ::: preview

    ∂r∂ωr(yωω)=(yωω){(log⁡y)r+∑i=1r(−1)Ir⋯(r−i+1)(log⁡y)riωi}\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\} ∂ωr∂r​(ωyω​)=(ωyω​){(logy)r+i=1∑r​ωi(−1)Ir⋯(r−i+1)(logy)ri​}

    :::

转义

可以通过在 $ 字符之前使用 \ 或在 $ 字符前后添加空格来完成转义:

::: preview

a=1a=1a=1 是一个 TeX 方程,而 $ a=1 $ 和 $a=1$ 不是。

:::

支持列表

TeX 教程:

  • TeX 教程
  • TeX 速查表

插件教程和常见问题: TeX

Katex:

  • KaTeX 支持功能
  • KaTeX 支持列表

Mathjax:

  • 支持的 TeX/LaTeX 命令

配置项

type

  • 类型:'katex' | 'mathjax'

  • 详情:

    用于渲染 TeX\TeXTE​X 内容的包。

    • 'katex':使用 KaTeX
    • 'mathjax':使用 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 输出解析器的选项。
在 GitHub 上编辑此页
上次更新: 2025/6/17 18:43
贡献者: 张怀文, pengzhanbo, Mister-Hope
上一页
markdown-hint
下一页
markdown-preview