Где найти полное форматирование 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:

Example of generated docx document with sources macros

Example of generated docx document with sources macros

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

Поддерживаются все сайты, которые в ответ на HTTP-запрос сразу возвращают полный HTML без проверок на ботов. Расширенный функционал доступен только для сайта arXiv.

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

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

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

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

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

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

Путь указывается относительно файла .md. Поддерживаемые форматы: PNG, JPEG, GIF, BMP.

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

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

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

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

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

Да. Примеры представлены на главной странице MGost.