跳至主要内容

撰写数学表达式

使用 Markdown 在 GitHub 上显示数学表达式。

关于撰写数学表达式

为清晰地表达数学表达式,GitHub 支持在 Markdown 中使用 LaTeX 格式的数学公式。更多信息,请参见 Wikibooks 中的 LaTeX/Mathematics

GitHub 的数学公式渲染功能使用 MathJax;这是一个基于 JavaScript 的开源显示引擎。MathJax 支持广泛的 LaTeX 宏和一些有用的辅助功能扩展。更多信息,请参见 MathJax 文档MathJax 可访问性扩展文档

数学表达式的渲染功能可在 GitHub Issues、GitHub Discussions、pull requests、wiki 和 Markdown 文件中使用。

编写行内表达式

有两种方法可以将数学表达式作为行内文本:你可以用美元符号 ($) 将表达式括起来,或者用 $` 开始表达式,用 `$ 结束表达式。当你编写的表达式包含与 Markdown 语法重叠的字符时,后一种语法非常有用。更多信息,请参见“基本写作和格式语法”。

This sentence uses `$` delimiters to show math inline:  $\sqrt{3x-1}+(1+x)^2$

Screenshot of rendered Markdown showing how a mathematical expression displays on GitHub. The equation is the square root of 3 x minus 1 plus open paren 1 plus x close paren squared.

This sentence uses $\` and \`$ delimiters to show math inline:  $`\sqrt{3x-1}+(1+x)^2`$

Screenshot of rendered Markdown showing how a mathematical expression displays inline on GitHub. The equation is the square root of 3 x minus 1 plus open paren 1 plus x close paren squared.

编写块级表达式

要添加块级数学表达式,请另起一行并用两个美元符号 $$ 将表达式括起来。

**The Cauchy-Schwarz Inequality**
$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$

Screenshot of rendered Markdown showing how a complex equation displays on GitHub. The bolded text reads "The Cauchy-Schwarz Inequality". Below the text, there is an equation showing open paren the sum from k equals 1 to n of a sub k b sub k close paren squared is less than or equal to open paren the sum from k equals 1 to n of a sub k squared close paren times open paren the sum from k equals 1 to n of b sub k squared close paren.

或者,您可以使用 ```math 代码块语法将数学表达式显示为块级。使用此语法,您不需要使用 $$ 定界符。以下将与上述渲染效果相同。

**The Cauchy-Schwarz Inequality**

```math
\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)
```

在数学表达式内和同一行中书写美元符号

要在与数学表达式同一行中显示美元符号作为字符,您需要转义非分隔符 $ 以确保行正确渲染。

  • 在数学表达式内,在显式的 $ 之前添加 \ 符号。

    This expression uses `\$` to display a dollar sign: $`\sqrt{\$4}`$
    

    Screenshot of rendered Markdown showing how a backslash before a dollar sign displays the sign as part of a mathematical expression.

  • 在数学表达式之外,但在同一行上,使用 span 标签围绕显式的 $

    To split <span>$</span>100 in half, we calculate $100/2$
    

    Screenshot of rendered Markdown showing how span tags around a dollar sign display the sign as inline text rather than part of a mathematical equation.

进一步阅读