Skip to main content

Enterprise Server 3.20 は、現在リリース候補として使用できます。

数式の記述

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

この機能を使用できるユーザーについて

Markdown は、GitHub Web インターフェイスで使用できます。

数式の記述について

数式を明確に伝えるために、GitHub は、Markdown 内で LaTeX 形式の数式をサポートしています。 詳細については、Wikibooks の「LaTeX/Mathematics」を参照してください。

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

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

インラインエクスプレッションの記述

テキストのインラインで数式を区切るには 2 つのオプションがあります。 式をドル記号 ($) で囲むか、または式を $` で開始し、`$ で終了することができます。 後者の構文は、記述する式に、マークダウン構文と重複する文字が含まれている場合に便利です。 詳しくは、「基本的な書き込みと書式設定の構文」をご覧ください。

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

「3x - 1 の平方根に、(1 + x) の二乗を足す」というインライン数式が示されている Markdown がレンダリングされたスクリーンショット。

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

バッククォート構文を用いたインライン数式を含む Markdown のレンダリングスクリーンショット: 3x の平方根から 1 を引き、その後 (1 プラス x) の 2 乗を足した数式が示されています。

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

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

ヒント

.md ファイルに記述している場合は、次の例に示すように、行の末尾をバックスラッシュにするなど、特定の書式を使って改行を作成する必要があります。 Markdown の改行の詳細については、「基本的な書き込みと書式設定の構文」を参照してください。

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

レンダリングされた Markdown のスクリーンショット。複雑な数式が示されています。 不等式の数式の上に、"コーシーシュワルツの不等式" という太字のテキストが表示されています。

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

    レンダリングされた Markdown のスクリーンショット。ドル記号を span タグで囲んで、数式の一部としてではなく、インライン テキストとして記号を表示する方法を示しています。

参考資料

  •         [MathJax の Web サイト](http://mathjax.org)
    
  •         [GitHubでの記述と書式設定を始める](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github)
    
  •         [GitHubフレーバーマークダウン仕様](https://github.github.com/gfm/)