Написание математических выражений

Для отображения математических выражений в GitHub используйте Markdown.

Кто может использовать эту функцию?

Markdown можно использовать в веб-интерфейсе GitHub .

В этой статье

О написании математических выражений

Чтобы обеспечить четкое взаимодействие математических выражений, GitHub поддерживает математические выражения в формате LaTeX в Markdown. Дополнительные сведения см. на странице LaTeX/Mathematics веб-сайта Wikibooks.

Функция отображения математических выражений GitHub использует MathJax. Это подсистема отображения с открытым кодом на основе JavaScript. MathJax поддерживает широкий спектр макросов LaTeX и несколько полезных расширений специальных возможностей. Дополнительные сведения см. в документации по MathJax и расширениям специальных возможностей MathJax.

Визуализация математических выражений доступна в файлах GitHub Issues, GitHub Discussions, запросах на вытягивание, вики-файлах и файлах Markdown.

Написание встроенных выражений

Чтобы включить в текст математические выражения, разделите выражение символами $доллара.

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

Снимок экрана: отрисованный Markdown, показывающий, как математическое выражение отображается на GitHub. Уравнение — это квадратный корень 3 x минус 1 плюс открытый парен 1 плюс x близкий парен квадрат.

Написание выражений в виде блоков

Чтобы добавить математическое выражение в виде блока, запустите новую строку и разделите выражение двумя символами доллара $$.

Tip

Если вы пишете в 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, показывающий, как сложное уравнение отображается на GitHub. Полужирный текст считывает "Кучи-Шварц неравенство". Под текстом есть уравнение, показывающее формулу равенства Cauchy-Schwarz.

Кроме того, для отображения математического выражения в виде блока вы можете использовать синтаксис блока кода ```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, показывающий, как обратная косая черта перед знаком доллара отображает знак как часть математического выражения.

  • За пределами математического выражения, но в той же строке заключите явный знак $ в теги диапазона.

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

    Снимок экрана: отрисованный Markdown, показывающий, как теги диапазона вокруг знака доллара отображаются как встроенный текст, а не часть математического уравнения.

Дополнительные материалы