HUGO 中文文档

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
gohugoio Star
  • 关于
    • 本节内容
    • 简介
    • 特性
    • 隐私
    • 安全
    • 许可证
  • 安装
    • 本节内容
    • macOS
    • Linux
    • Windows
    • BSD
  • 快速上手
    • 本节内容
    • 快速入门
    • 基本用法
    • 目录结构
    • 配置
    • 配置标记
    • 术语表
    • 配置构建
    • 外部学习资源
  • 快速参考
    • 本节内容
    • 表情符号
    • 函数
    • 方法
    • 页面集合
  • 内容管理
    • 本节内容
    • 组织
    • 页面包
    • 内容格式
    • Front matter (前置 matter)
    • 构建选项
    • 页面资源
    • 图片处理
    • 短代码
    • 相关内容
    • 章节
    • 内容类型
    • 原型
    • 分类法
    • 摘要
    • 链接和交叉引用
    • URL 管理
    • 菜单
    • 评论
    • 多语言
    • Markdown 属性
    • 语法高亮
    • 图表
    • 数学公式
    • 数据源
    • 内容适配器
  • 模板
    • 本节内容
    • 简介
    • 模板类型
    • 查找顺序
    • 基模板
    • 首页模板
    • 单个模板
    • 章节模板
    • 分类模板
    • 术语模板
    • 局部模板
    • 内容视图模板
    • 短代码模板
    • 站点地图模板
    • RSS 模板
    • 404 模板
    • robots.txt 模板
    • 菜单
    • 分页
    • 内嵌模板
    • 自定义输出格式
  • 函数
    • 本节内容
    • css
    • fmt
    • go 模板
    • hugo
    • js
    • lang
    • openapi3
    • os
    • urls
    • 全局
    • 加密
    • 反射
    • 变形
    • 变换
    • 哈希
    • 图像
    • 图表函数
    • 字符串
    • 安全函数
    • 局部模板函数
    • 数学
    • 数据
    • 时间
    • 模板
    • 比较
    • 类型转换
    • 编码
    • 调试
    • 资源
    • 路径
    • 集合
  • 方法
    • 本节内容
    • Duration
    • Menu
    • Page
    • Pager
    • Resource
    • Shortcode
    • Site
    • Taxonomy
    • Time
    • 菜单项
    • 页面
  • 渲染钩子
    • 本节内容
    • 简介
    • 块引用
    • 代码块
    • 标题
    • Images
    • 链接
    • Passthrough
    • 表格
  • Hugo 模块
    • 本节内容
    • 配置 Hugo 模块
    • 使用 Hugo 模块
    • 主题组件
  • Hugo 管道
    • 本节内容
    • 简介
    • 将 Sass 编译为 CSS
    • PostCSS
    • PostProcess
    • JavaScript 构建
    • 资源压缩
    • 连接资产
    • 指纹和 SRI 哈希
    • 从字符串创建资源
    • 从模板创建资源
  • 命令行界面
  • 故障排除
    • 本节内容
    • Audit
    • 日志记录
    • 检查
    • 弃用
    • 性能
    • FAQs
  • 开发者工具
    • 本节内容
    • 编辑器插件
    • 前端
    • Search
    • 迁移
    • 其他项目
  • 托管和部署
    • 本节内容
    • Hugo 部署
    • 使用 Rclone 部署
    • 使用 Rsync 部署
    • 在 21YunBox 上托管
    • 在 AWS Amplify 上托管
    • 在 Cloudflare Pages 上托管
    • 在 Firebase 上托管
    • 在 GitLab Pages 上托管
    • 在 Netlify 上托管
    • 在 Render 上托管
    • 托管在 Azure 静态 Web 应用上
    • 托管在 GitHub Pages 上
    • 托管在 KeyCDN 上
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
CONTENT MANAGEMENT

Markdown 中的数学公式

使用 LaTeX 或 TeX 排版语法在 Markdown 中包含数学方程式和表达式。
New in v0.122.0 \[ \begin{aligned} KL(\hat{y} || y) &= \sum_{c=1}^{M}\hat{y}_c \log{\frac{\hat{y}_c}{y_c}} \\ JS(\hat{y} || y) &= \frac{1}{2}(KL(y||\frac{y+\hat{y}}{2}) + KL(\hat{y}||\frac{y+\hat{y}}{2})) \end{aligned} \]

概述

在学术和科学出版物中,使用 LaTeX 或 TeX 编写的数学方程式和表达式很常见。您的浏览器通常使用开源JavaScript显示引擎(例如 MathJax 或 KaTeX )来呈现此数学标记。

例如,这是本页顶部显示的方程式的数学标记:

\[
\begin{aligned}
KL(\hat{y} || y) &= \sum_{c=1}^{M}\hat{y}_c \log{\frac{\hat{y}_c}{y_c}} \\
JS(\hat{y} || y) &= \frac{1}{2}(KL(y||\frac{y+\hat{y}}{2}) + KL(\hat{y}||\frac{y+\hat{y}}{2}))
\end{aligned}
\]

方程式和表达式可以与其他文本内联显示,也可以作为独立的块显示。块呈现也称为“显示”模式。

方程式或表达式是内联显示还是块显示,取决于围绕数学标记的分隔符。分隔符成对定义,每一对包含一个起始分隔符和一个结束分隔符。起始和结束分隔符可以相同,也可以不同。常见的分隔符对在 步骤1 中显示。

以下描述的方法避免依赖于平台特定的功能,例如简码或代码块渲染钩子。相反,它使用标准化的数学方程式和表达式的标记格式,与GitHub、GitLab、 Microsoft VS Code 、 Obsidian 、 Typora 等使用的渲染引擎兼容。

设置

按照以下说明,使用LaTeX或TeX排版语法在Markdown中包含数学方程式和表达式。

步骤1

在您的站点配置中启用并配置Goldmark passthrough扩展 。passthrough扩展保留分隔文本片段内的原始Markdown,包括分隔符本身。

hugo.
     
markup:
  goldmark:
    extensions:
      passthrough:
        delimiters:
          block:
          - - \[
            - \]
          - - $$
            - $$
          inline:
          - - \(
            - \)
        enable: true
params:
  math: true
[markup]
  [markup.goldmark]
    [markup.goldmark.extensions]
      [markup.goldmark.extensions.passthrough]
        enable = true
        [markup.goldmark.extensions.passthrough.delimiters]
          block = [['\[', '\]'], ['$$', '$$']]
          inline = [['\(', '\)']]
[params]
  math = true
{
   "markup": {
      "goldmark": {
         "extensions": {
            "passthrough": {
               "delimiters": {
                  "block": [
                     [
                        "\\[",
                        "\\]"
                     ],
                     [
                        "$$",
                        "$$"
                     ]
                  ],
                  "inline": [
                     [
                        "\\(",
                        "\\)"
                     ]
                  ]
               },
               "enable": true
            }
         }
      }
   },
   "params": {
      "math": true
   }
}

除非您在 front matter 中将 math 参数设置为 false ,否则上述配置将在每个页面上启用数学渲染。要根据需要启用数学渲染,请在站点配置中将 math 参数设置为 false ,并在front matter中将 math 参数设置为 true 。如 步骤3 所示,在您的基础模板中使用此参数。

上述配置排除了使用 $...$ 分隔符对内联方程式。虽然您可以将此分隔符对添加到配置和JavaScript中,但在数学上下文之外使用时,您需要对 $ 符号进行双重转义以避免意外的格式化。

有关详细信息,请参见 内联分隔符 部分。

要禁用内联片段的passthrough,请从配置中省略 inline 键:

hugo.
     
markup:
  goldmark:
    extensions:
      passthrough:
        delimiters:
          block:
          - - \[
            - \]
          - - $$
            - $$
[markup]
  [markup.goldmark]
    [markup.goldmark.extensions]
      [markup.goldmark.extensions.passthrough]
        [markup.goldmark.extensions.passthrough.delimiters]
          block = [['\[', '\]'], ['$$', '$$']]
{
   "markup": {
      "goldmark": {
         "extensions": {
            "passthrough": {
               "delimiters": {
                  "block": [
                     [
                        "\\[",
                        "\\]"
                     ],
                     [
                        "$$",
                        "$$"
                     ]
                  ]
               }
            }
         }
      }
   }
}

您可以定义自己的起始和结束分隔符,前提是它们与您在 步骤2 中设置的分隔符匹配。

hugo.
     
markup:
  goldmark:
    extensions:
      passthrough:
        delimiters:
          block:
          - - '@@'
            - '@@'
          inline:
          - - '@'
            - '@'
[markup]
  [markup.goldmark]
    [markup.goldmark.extensions]
      [markup.goldmark.extensions.passthrough]
        [markup.goldmark.extensions.passthrough.delimiters]
          block = [['@@', '@@']]
          inline = [['@', '@']]
{
   "markup": {
      "goldmark": {
         "extensions": {
            "passthrough": {
               "delimiters": {
                  "block": [
                     [
                        "@@",
                        "@@"
                     ]
                  ],
                  "inline": [
                     [
                        "@",
                        "@"
                     ]
                  ]
               }
            }
         }
      }
   }
}
步骤2

创建一个加载MathJax或KaTeX的部分模板。下面的示例加载MathJax,或者您可以按照 引擎 部分中的说明使用KaTeX。

layouts/partials/math.html
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js"></script>
<script>
  MathJax = {
    tex: {
      displayMath: [['\\[', '\\]'], ['$$', '$$']],  // block
      inlineMath: [['\\(', '\\)']]                  // inline
    }
  };
</script>

上述分隔符必须与站点配置中的分隔符匹配。

步骤3

从基础模板有条件地调用部分模板。

layouts/_default/baseof.html
<head>
  ...
  {{ if .Param "math" }}
    {{ partialCached "math.html" . }}
  {{ end }}
  ...
</head>

上面的示例在您已将front matter中的 math 参数设置为 true 时加载部分模板。如果您没有在front matter中设置 math 参数,则条件语句将回退到站点配置中的 math 参数。

步骤4

使用LaTeX或TeX排版语法在Markdown中包含数学方程式和表达式。

content/math-examples.md
这是一个内联\(a^*=x-b^*\)方程式。

这些是块方程式:

\[a^*=x-b^*\]

\[ a^*=x-b^* \]

\[
a^*=x-b^*
\]

这些也是块方程式:

$$a^*=x-b^*$$

$$ a^*=x-b^* $$

$$
a^*=x-b^*
$$

如果在站点配置中将 math 参数设置为 false ,则必须在front matter中将 math 参数设置为 true 。例如:

content/math-examples.md
     
---
date: 2024-01-24T18:09:49-08:00
params:
  math: true
title: Math examples
---
+++
date = 2024-01-24T18:09:49-08:00
title = 'Math examples'
[params]
  math = true
+++
{
   "date": "2024-01-24T18:09:49-08:00",
   "params": {
      "math": true
   },
   "title": "Math examples"
}

内联分隔符

上述配置、JavaScript和示例使用 \(...\) 分隔符对内联方程式。 $...$ 分隔符对是常见的替代方案,但如果在数学上下文之外使用 $ 符号,则使用它可能会导致意外的格式化。

如果将 $...$ 分隔符对添加到配置和JavaScript中,则无论页面上是否启用了数学渲染,在数学上下文之外都必须对 $ 进行双重转义。例如:

A \\$5 bill _saved_ is a \\$5 bill _earned_.

如果您使用 $...$ 分隔符对内联方程式,并且偶尔在数学上下文之外使用 $ 符号,则必须使用MathJax而不是KaTeX来避免由 此KaTeX限制 造成的意外格式化。

引擎

MathJax和KaTeX是开源JavaScript显示引擎。这两个引擎都很快,但在撰写本文时,MathJax v3.2.2略快于KaTeX v0.16.9。

如果您使用 $...$ 分隔符对内联方程式,并且偶尔在数学上下文之外使用 $ 符号,则必须使用MathJax而不是KaTeX来避免由 此KaTeX限制 造成的意外格式化。

有关详细信息,请参见 内联分隔符 部分。

要使用KaTeX而不是MathJax,请将 步骤2 中的部分模板替换为此:

layouts/partials/math.html
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css" integrity="sha384-n8MVd4RsNIU0tAv4ct0nTaAbDJwPJzDEaqSD1odI+WdtXRGWt2kTvGFasHpSy3SV" crossorigin="anonymous">
<script defer src="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.js" integrity="sha384-XjKyOOlGwcjNTAIQHIpgOno0Hl1YQqzUOEleOLALmuqehneUG+vnGctmUb0ZY0l8" crossorigin="anonymous"></script>
<script defer src="https://cdn.jsdelivr.net/npm/[email protected]/dist/contrib/auto-render.min.js" integrity="sha384-+VBxd3r6XgURycqtZ117nYw44OOcIax56Z4dCRWbxyPt0Koah1uHoK0o4+/RRE05" crossorigin="anonymous"></script>
<script>
  document.addEventListener("DOMContentLoaded", function() {
    renderMathInElement(document.body, {
      delimiters: [
        {left: '\\[', right: '\\]', display: true},   // block
        {left: '$$', right: '$$', display: true},     // block
        {left: '\\(', right: '\\)', display: false},  // inline
      ],
      throwOnError : false
    });
  });
</script>

上述分隔符必须与站点配置中的分隔符匹配。

化学

MathJax和KaTeX都支持化学方程式。例如:

$$C_p[\ce{H2O(l)}] = \pu{75.3 J // mol K}$$
$$C_p[\ce{H2O(l)}] = \pu{75.3 J // mol K}$$

如上 步骤2 所示,MathJax无需额外配置即可支持化学方程式。要向KaTeX添加化学支持,请按照KaTeX 文档 中的说明启用mhchem扩展。

See also

  • Front matter (前置 matter)
  • Markdown 属性
  • Passthrough
  • PostCSS
  • URL 管理

On this page

  • 概述
  • 设置
  • 内联分隔符
  • 引擎
  • 化学
Last updated: January 10, 2025: 添加 gtm 谷歌代码管理 (6220bf5)
Improve this page
By the Hugo Authors
Hugo Logo
  • File an Issue
  • Get Help
  • @GoHugoIO
  • @spf13
  • @bepsays
 

Hugo Sponsors

Your Company?
 

The Hugo logos are copyright © Steve Francia 2013–2025.

The Hugo Gopher is based on an original work by Renée French.

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
  • 关于
  • 安装
  • 快速上手
  • 快速参考
  • 内容管理
  • 模板
  • 函数
  • 方法
  • 渲染钩子
  • Hugo 模块
  • Hugo 管道
  • 命令行界面
  • 故障排除
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护