Команда GitHub рассказала о новой функции, которая позволяет записывать математические формулы в Markdown. Разработчики впервые попросили добавить эту возможность восемь лет назад.
Как использовать новую функцию
По словам представителей ИТ-хостинга, математические выражения – важная часть обмена информацией между разработчиками, инженерами и учеными. Чтобы визуализировать формулы, GitHub стал использовать библиотеку MathJax, главный лозунг которой – «Красивая и доступная математика во всех браузерах».
Выражения нужно записывать в формате верстки TeX или LaTeX. Чтобы формулы были автоматически визуализированы новой функцией, пользователю нужно записать вводные данные между специальными символами $ или $$.
Например, разработчик может в GitHub Markdown написать такое выражение:
«Когда $D > 0$, уравнение $(ax^2 + bx + c = 0)$ имеет два корня, которые можно найти следующим образом:
$$ x_{1}, x_{2} = {-b \pm \sqrt{D} \over 2a} $$
$$ D = b^2 - 4ac$$»
Система преобразует эту формулу и отобразит ее следующим образом:
Средства визуализации репозитория
Также представители GitHub подготовили разъяснения об особенностях оформления выражений. Одиночный символ $ используется для встраивания формул в сам текст, а двойной $$ нужен для создания отдельного блока с формулой. Если нужно напечатать знак доллара в одной строке с выражением, то его следует экранировать при помощи обратной косой черты или тега <span>. Это может быть полезно в случаях, когда данный символ используется в самой формуле, которую нужно визуализировать.
В феврале 2022 года GitHub добавила нативную поддержку диаграмм в файлах Markdown при помощи генератора Mermaid.js, который позволяет создавать различные блок-схемы, UML-диаграммы, графики коммитов и диаграммы Ганта. При добавлении в md-файл блока кода, который помечен как mermaid, система создает новый фрейм iframe и передает отмеченный код в Mermaid.js, где он визуализируется как диаграмма. Результат работы функции отображается сразу же в браузере пользователя.