doc/help/github_formula2.md
2026-08-28 14:54:58 +03:00

4.8 KiB
Raw Blame History

2

Да, вы правы. Если \boxed{...} заключить в поддерживаемый GitHub математический блок, например $$ ... $$, он может корректно отобразиться в текущем интерфейсе GitHub или GitHub-подобном рендерере.

Поэтому формулировка «недопустимый пример» была неточной. Правильнее разделять:

  1. LaTeX-команды, которые технически отображаются в GitHub.
  2. LaTeX-команды, которые вы не хотите использовать в техническом документе.

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

Исправленное правило

Используй математические конструкции, поддерживаемые GitHub Markdown, включая:

  • $ ... $;
  • $$ ... $$;
  • \( ... \);
  • \[ ... \];
  • стандартные LaTeX-команды, которые корректно отображаются в GitHub.

При этом не используй:

  • \boxed;
  • рамочные конструкции;
  • декоративное выделение формул;
  • лишние команды форматирования;
  • неподдерживаемые или нестабильные команды;
  • пользовательские макросы;
  • команды, не требуемые для содержания формулы.

Главное требование:

Формулы можно заключать в поддерживаемые GitHub математические delimiters, но не следует использовать \boxed и другие нежелательные рамочные или декоративные конструкции.

Исправленный пример

Допустимый вариант:

$$
K_{\mathrm{г,ст}} =
\frac{\mu_{01}(\lambda_{21}+\mu_{12})}
{\lambda_{10}\lambda_{21}
+\mu_{01}\lambda_{21}
+\mu_{01}\mu_{12}}
$$

Вариант, который не следует использовать:

$$
\boxed{
K_{\mathrm{г,ст}} =
\frac{\mu_{01}(\lambda_{21}+\mu_{12})}
{\lambda_{10}\lambda_{21}
+\mu_{01}\lambda_{21}
+\mu_{01}\mu_{12}}
}
$$

Причина запрета:

  • не техническая несовместимость с GitHub;
  • отсутствие необходимости в рамке;
  • предпочтение нейтрального оформления формул;
  • требование отделять содержание формулы от декоративного форматирования.

Обновленная формулировка для промпта

Вместо прежнего текста следует использовать:

Используй математические конструкции, поддерживаемые GitHub Markdown, включая $, $$, \( \), \[ \] и стандартные LaTeX-команды.

Формулы можно оформлять в математических блоках GitHub.

Не используй \boxed и другие рамочные или декоративные конструкции, даже если они корректно отображаются в GitHub.

Не используй пользовательские макросы, внешние LaTeX-пакеты и нестандартные команды, если они не нужны для содержания формулы.

Главное требование: формулы должны быть математически корректными, GitHub-совместимыми и оформленными без рамок и декоративного выделения.

То есть корректное название режима:

GitHub-совместимый технический Markdown с поддерживаемыми LaTeX-формулами без рамочных и декоративных конструкций.

3

ver

https://www.perplexity.ai/

ver 1

Оформи в режиме GitHub Markdown, формулы без LaTeX-обертки

ver 2

Оформи в GitHub Markdown с поддерживаемым LaTeX. Не используй \boxed и другие команды, которые GitHub не поддерживает, даже внутри математических delimiters.