Skip to main content
ドキュメントへの更新が頻繁に発行されており、このページの翻訳はまだ行われている場合があります。 最新の情報については、「英語のドキュメント」を参照してください。
現在、GitHub AE は限定的リリースです。

数式の記述

Markdown を使って、GitHub で数式を表示します。

数式の記述について

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

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

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

インライン式の記述

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

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

平方根記号と指数を持つ数式が GitHub 上でどのように表示されるかを示す、レンダリングされた Markdown のスクリーンショット。

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

数式をブロックとして追加するには、新しい行を開始し、式を 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 のスクリーンショット。

インラインで数式の内外にドル記号を記述する

数式と同じ行にドル記号を文字として表示するには、区切り記号でない $ をエスケープして、行が正しくレンダリングされるようにする必要があります。

  • 数式内では、明示する $ の前に \ 記号を追加します。

    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 のスクリーンショット。

参考資料