Команда GitHub представила нативную поддержку математических выражений в README-файлах

В блоге GitHub сообщили, что математические формулы и выражения — важная часть обмена информацией между разработчиками, инженерами и учеными. Поэтому теперь в GitHub появилась нативная функция для простой записи выражений в Markdown.

e15242a5f0d0c9a1e82bc6219445aa31.png

Для визуализации формул GitHub использует популярную библиотеку MathJax, которая разрабатывается под лозунгом «Красивая и доступная математика во всех браузерах». Команда GitHub рассказала, что подобную функцию пользователи впервые запросили 8 лет назад, но реализовать её удалось только сейчас.

Для визуализации формул пользователю следует использовать ключевые символы в виде $ или $$. Система автоматически визуализирует все, что записано между этими символами. Сами формулы следует записывать в формате 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$$

будет отображаться следующим образом:

ed1aa4991d99b1324efb7a67bba42402.png

Важно отметить, что одиночный символ используется для встраивания формул в сам текст, а двойной создает отдельный блок с формулой. Для печати знака доллара в одной строке с выражением следует использовать экранирование в виде обратной косой черты или тега .

К примеру, если в самой формуле необходимо использовать символ доллара, то перед ним необходимо разместить обратную косую черту.

Используйте конструкцию `\$` для вставки символа доллара в формулу: $\sqrt{\$4}$

f8cccd9ceda8a35b84ab96f96f7be5d8.png

Если символ доллара необходимо записать в одной строке с формулой, то его следует взять в тег .

Чтобы разделить $100 пополам, нам надо вычислить $100/2$

2784d8f898fa9476ee31a7f55d69751a.png

В середине февраля 2022 года команда GitHub представила нативную поддержку диаграмм Mermaid.js в md-файлах репозиториев. Информационная служба Хабра, в свою очередь, подготовила обзор технологии и полноценное руководство пользователя на русском языке.

© Habrahabr.ru