数式の記述

数式の記述について

数式をわかりやすくやり取りできるように、GitHub Enterprise Server では Markdown 内の LaTeX 形式の数式がサポートされています。詳細については、Wikibooks の「LaTeX/Mathematics」を参照してください。

GitHub の数式レンダリング機能では、オープンソースの JavaScript ベースの表示エンジンである MathJax が使用されます。 MathJax では、幅広い LaTeX マクロと、いくつかの便利なアクセシビリティ拡張機能がサポートされています。詳細については、MathJax のドキュメントと MathJax アクセシビリティ拡張機能のドキュメントを参照してください。

数式のレンダリングは、GitHub Issues、GitHub Discussions、pull request、Wiki、Markdown ファイルで利用できます。

インライン式の記述

数式をテキスト内にインラインで含めるには、式をドル記号 $ で区切ります。

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

$数式が GitHub 上にどのように表示されるかを示す、レンダリングされた Markdown のスクリーンショット。数式は、(3x - 1) の平方根 + (1 + x) の 2 乗です。$

ブロックとして式を記述する

数式をブロックとして追加するには、新しい行を開始し、式を 2 つのドル記号 $$ で区切ります。

**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)$$

$複雑な方程式が GitHub 上でどのように表示されるかを示す、レンダリングされた Markdown のスクリーンショット。太字のテキストには、"Cauchy-Schwarz 不等式" と書かれています。テキストの下には、(k = 1 から n における ak * bk (k は下付き文字) の総和) の 2 乗が、(k = 1 から n における ak (k は下付き文字) の 2 乗の総和) * (k = 1 から n における bk (k は下付き文字) の 2 乗の総和) 以下であることを示す数式があります。$

または、```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}`$

$ドル記号の前にあるバックスラッシュが記号を数式の一部として表示することを示す、レンダリングされた Markdown のスクリーンショット。$

数式外の同じ行では、明示する $ の周りに span タグを使用します。
```
To split <span>$</span>100 in half, we calculate $100/2$
```
$ドル記号を囲む span タグが記号を数式の一部ではなくインラインテキストとして表示することを示す、レンダリングされた Markdown のスクリーンショット。$

この記事の内容