Где найти полное форматирование Markdown?

MGost следует стандарту GitHub Flavored Markdown.

У меня сломаны номера страниц содержания

Так как содержание рендерится первым, номера страниц других заголовков ещё неизвестны — Word ставит им 1 по умолчанию. Для обновления нажмите Ctrl + A (выделить всё), затем F9.

Как добавить ссылку, чтобы она отобразилась в списке использованных источников?

Для этого используйте название ссылки в двойных квадратных скобках. Примеры:

1. В качестве примера можно привести компьютерную игру [[Rocket League]](https://store.epicgames.com/ru/p/rocket-league).
1. В качестве примера можно привести компьютерную игру Rocket League [[*RL]](https://store.epicgames.com/ru/p/rocket-league).
1. В качестве примера можно привести компьютерную игру Rocket League [[*RL2]](https://store.epicgames.com/ru/p/rocket-league "Описание игры Rocket League").

# **Источники
`sources(5)`

Текст внутри двойных скобок — это ключ источника, используемый для объединения повторных ссылок на один URL. Он не отображается в документе — ссылка всегда заменяется на номер вида [1]. Ключ может быть любым: [[Rocket League]], [[RL]], [[ист1]] — значения не имеет.

Если в кавычках после URL указано произвольное описание, оно используется как название источника вместо автоматически полученного с сайта:

[[*RL]](https://store.epicgames.com/ru/p/rocket-league "Описание игры Rocket League")

Аргумент sources(5) задаёт начальный номер нумерации — источники будут пронумерованы начиная с 5. Это нужно, если часть источников добавлена вручную до макроса.

Сгенерированный файл Word:

Повторяйте полную ссылку [[ключ]](url) при каждом упоминании, а не голый номер [1]: тогда при удалении текста не останется номера, указывающего в никуда, — источник исчезнет из списка вместе с последней ссылкой на него.

Ссылки внутри ячеек таблиц не собираются: в ячейке останется [ключ], а источника не будет в списке. Ссылайтесь в тексте до или после таблицы.

Как оформляется строка источника?

Строку источника MGost пишет сам. Вид строки зависит от названия в кавычках (или полученного с сайта) и проверяется в таком порядке.

1. Полное описание. Название, в котором есть // или которое начинается с автора (Фамилия, И. О. или Фамилия И. О.), выводится как написано, без «» и без [Электронный ресурс]. С сайта ничего не скачивается. Так оформляют статьи из журналов: в кавычках пишется всё описание по ГОСТ.

[[Адаменко]](https://cyberleninka.ru/article/n/... "Адаменко, А. П. Банкротство индивидуальных предпринимателей – правовые проблемы / А. П. Адаменко // Имущественные отношения в РФ. – 2025. – №8 (287). – С. 76–84")

1.	Адаменко, А. П. Банкротство индивидуальных предпринимателей – правовые проблемы / А. П. Адаменко // Имущественные отношения в РФ. – 2025. – №8 (287). – С. 76–84. — URL: https://cyberleninka.ru/article/n/... (дата обращения: 14.03.2026).

Описание, в котором нет // и которое не начинается с автора, считается обычным названием и целиком попадает в «».

2. Нормативный акт. Название акта переписывается в едином порядке, см. ниже:

[[ФЗ-127]](https://www.consultant.ru/document/cons_doc_LAW_39331/ "О несостоятельности (банкротстве) : Федеральный закон от 26.10.2002 №127-ФЗ (ред. от 23.03.2026)")

1.	Федеральный закон от 26.10.2002 № 127-ФЗ (ред. от 23.03.2026) «О несостоятельности (банкротстве)» // КонсультантПлюс : справочно-правовая система. — URL: https://www.consultant.ru/document/cons_doc_LAW_39331/ (дата обращения: 14.03.2026).

3. Обычное название. Всё остальное выводится в «», за ним [Электронный ресурс], URL и дата обращения (для сайтов из списка ниже — в формате сайта):

[[pep8]](https://peps.python.org/pep-0008/ "PEP 8 — Style Guide for Python Code")

1.	«PEP 8 — Style Guide for Python Code», [Электронный ресурс]. — URL: https://peps.python.org/pep-0008/ (дата обращения: 14.03.2026).

Дата обращения — случайный день в диапазоне макроса work_interval.

Как сослаться на закон или другой нормативный акт?

Название считается нормативным актом, если оно написано в одном из этих порядков (в кавычках или так, как его отдают КонсультантПлюс и Гарант):

• по ГОСТ Р 7.0.100: О несостоятельности (банкротстве) : Федеральный закон от 26.10.2002 № 127-ФЗ
• как принято на юрфаках: Федеральный закон от 26.10.2002 № 127-ФЗ «О несостоятельности (банкротстве)»
• вид, затем название: Федеральный закон "О несостоятельности (банкротстве)" от 26.10.2002 N 127-ФЗ
• кодекс: "Уголовный кодекс Российской Федерации" (УК РФ) от 13.06.1996 N 63-ФЗ

Акт выводится как {вид} от {дата} № {номер} (ред. от {дата}) «{название}», кодекс — как Уголовный кодекс Российской Федерации от 13.06.1996 № 63-ФЗ (ред. от …).

• Вид — всё, что стоит перед от: Федеральный закон, Указ Президента РФ, Постановление Правительства РФ, Приказ Минфина России и т. д.
• Дата пишется как 26.10.2002 или 26 октября 2002 г. — выводится всегда 26.10.2002. N 127-ФЗ и №127-ФЗ выводятся как № 127-ФЗ.
• Редакция (ред. от DD.MM.YYYY) может стоять в любом месте названия и переносится после номера. КонсультантПлюс показывает её только у кодексов, у федеральных законов её не показывает ни один из сайтов: если она нужна, укажите её в кавычках. (последняя редакция), (с изм. и доп., …) и , с изм. от … отбрасываются.
• На других сайтах акт выводится с . — URL: …, без «» и без [Электронный ресурс].
• Название, не подходящее ни под один порядок, выводится как обычное.

Как сослаться на страницу или статью источника?

Укажите место после | внутри ключа:

См. [[Адаменко|78]](https://cyberleninka.ru/... "Адаменко, А. П. …").
Статья 5 [[ФЗ-127|ст. 5]](https://www.consultant.ru/... "…").

• Текст после первого | относится только к этой ссылке. Ключ до него объединяет ссылки как обычно: [[Адаменко|78]] и [[Адаменко]] — один источник.
• В тексте выводится [N, с. 78]. К номерам страниц, диапазонам и перечням (78, 78–80, 78, 80) добавляется с. , остальное выводится как написано: [N, ст. 5].
• В список источников место не попадает. [[ключ|]] — то же, что [[ключ]].

Не пишите место в самом ключе: [[ГК, ст. 223]] — другой ключ, и источник попадёт в список дважды.

Как оформить ссылки сносками?

Поставьте в начале документа макрос citations_as_footnotes: каждая ссылка станет постраничной сноской с полной строкой источника, а список источников останется. Не пишите номера [N] и сноски вручную.

Как пронумеровать страницы и включить переносы?

По умолчанию в документе нет ни номеров страниц, ни переносов. Большинство вузов требует номера страниц, многие — переносы. Их включают макросы page_numbers и set_hyphenation в начале документа:

`include(titul.docx, section)`
`work_interval(01.02.2026, 30.05.2026)`
`page_numbers(arabic)`
`set_hyphenation`

# **Содержание
`table_of_contents`

Какие сайты поддерживаются для создания умного содержания?

Поддерживаются все сайты, которые в ответ на HTTP-запрос сразу возвращают полный HTML без проверок на ботов. Для некоторых сайтов строка источника оформляется по-своему (адрес с www. и без него работает одинаково, а поддомен — как основной сайт: base.garant.ru оформляется как garant.ru):

• arXiv — название в кавычках игнорируется, авторы, название и год публикации берутся с сайта: Авторы. Название — arXiv, 2018.
• КонсультантПлюс — источник оформляется как справочно-правовая система: Гражданский кодекс Российской Федерации (ГК РФ) // КонсультантПлюс : справочно-правовая система. — URL: … (дата обращения: …).
• Гарант — так же: Название // Гарант : справочно-правовая система. — URL: … (дата обращения: …).
• КиберЛенинка — данные статьи берутся с сайта: Автор И. О. Название // Журнал. — 2025. — № 8. — С. 76–84. — URL: …. Название в кавычках заменяет только название статьи.

На КонсультантПлюс и Гаранте:

• Название берётся со страницы или из кавычек без обращения к сайту и выводится без «». Окончание // КонсультантПлюс (\ КонсультантПлюс, // Гарант, | ГАРАНТ) в названии в кавычках отрезается, чтобы имя системы не повторялось дважды.
• Закон или кодекс указывается своим адресом: [[УК]](https://www.consultant.ru/document/cons_doc_LAW_10699/). У кодексов из нескольких частей (ГК, НК) общая страница без даты и номера: ссылайтесь на нужную часть или укажите акт в кавычках.
• У статьи свой адрес, и она станет отдельным источником. Чтобы сослаться на статью акта, уже стоящего в списке, укажите место в источнике.

Полное описание выводится как написано и на этих сайтах: с сайта ничего не скачивается, // КонсультантПлюс, // Гарант или // КиберЛенинка не добавляются.

Сайты, которые не будут работать:

• Одностраничные приложения (React, Vue и др.) — сайт отдаёт пустую страницу без JavaScript
• Сайты с защитой от ботов (Cloudflare и аналоги) — запрос будет заблокирован
• Страницы, требующие авторизации — конвертер не имеет доступа к личным аккаунтам

В этих случаях укажите название источника вручную через кавычки после URL.

Как добавить изображение?

Изображения вставляются стандартным синтаксисом Markdown:

![Подпись к рисунку](./path/to/image.png)

Путь указывается относительно файла .md.

Подходит любое растровое изображение распространённого формата: PNG, JPEG, GIF, BMP, WEBP, TIFF и другие. Векторные форматы, например SVG, не поддерживаются — такой файл будет отмечен как повреждённый. Схемы удобнее строить макросом build_graph или сохранять в PNG.

Размер на странице подбирается автоматически:

• изображение показывается в натуральную величину — 96 пикселей на дюйм;
• если оно не помещается на странице (с учётом её ориентации и места под подпись), оно пропорционально уменьшается до размеров страницы;
• изображение никогда не увеличивается, поэтому маленькая картинка останется маленькой.

Сам файл по возможности вставляется без изменений. Изображение перекодируется, только если его нужно уменьшить до заданной плотности пикселей (см. макрос set_image_dpi), повернуть по метке ориентации камеры, перевести из CMYK или если формат не PNG и не JPEG. Тогда изображение с прозрачностью сохраняется в PNG вместе с прозрачностью, остальные — в JPEG. У анимированного GIF в документ попадает только первый кадр.

Если файл не найден — вставка не произойдёт, в интерфейсе появится предупреждение. Если файл повреждён — изображение не попадёт в документ, в интерфейсе появится ошибка.

Можно ли указать абсолютный путь или файл вне папки проекта?

Да. Изображения и макросы, читающие файлы (listing, include и другие), принимают путь вне папки документа: абсолютный — C:/Users/me/Pictures/scheme.png, /home/me/scheme.png — или выходящий наверх через .. — ../common/logo.png.

![Схема](C:/Users/me/Pictures/scheme.png)

`listing(Код программы): D:\projects\lab\main.py`

Сервер не читает файлы с вашего компьютера. Такой файл загружает MGost CLI вместе с проектом: сервер хранит его копию внутри проекта и при сборке подставляет её вместо указанного пути. В документ попадает версия файла с последней синхронизации.

На странице проекта эти файлы собраны в разделе «Внешние файлы». Их можно открыть, изменить и удалить, но нельзя переместить, переименовать или загрузить через сайт — только через MGost CLI. Внешний файл, на который документ больше не ссылается, удаляется с сервера после следующей успешной сборки.

Конвертация завершилась с ошибкой или результат выглядит неверно

Проверьте следующее:

• Макросы — каждый вызов макроса должен быть внутри одиночных обратных кавычек и не содержать переносов строк. Незакрытая кавычка может «поглотить» текст после неё.
• Пути к файлам — изображения и листинги ищутся по пути относительно .md-файла, если путь не абсолютный. Убедитесь, что файлы загружены и путь написан верно.
• LaTeX в формулах — синтаксическая ошибка в LaTeX не даст сгенерировать формулу.
• Уведомления — сообщения об ошибках и предупреждениях отображаются в интерфейсе после конвертации. Прочитайте их перед тем, как искать проблему вручную.
• Источники — если URL недоступен в момент конвертации, строка источника может быть пропущена или оказаться пустой. Ссылки внутри ячеек таблиц и начиная с заголовка «Заключение» в список не попадают.
• Номера страниц — page_numbers в середине главы включает номера с первой страницы этой главы (см. page_numbers).

Есть пример работы?

Да. Примеры представлены на главной странице MGost, а короткая работа с разбором каждой строки — на странице Пример.