数式の記述について
数式をわかりやすくやり取りできるように、GitHub Enterprise Server では Markdown 内の LaTeX 形式の数式がサポートされています。 詳細については、Wikibooks の「LaTeX/Mathematics」を参照してください。
GitHub の数式レンダリング機能では、オープンソースの JavaScript ベースの表示エンジンである MathJax が使用されます。 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$
This sentence uses $\` and \`$ delimiters to show math inline: $`\sqrt{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)$$
または、```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}`$
-
数式外の同じ行では、明示する
$
の周りに span タグを使用します。To split <span>$</span>100 in half, we calculate $100/2$