Шаблоны и переменные Pandoc

Все примеры расположены в репозитории.

При генерации целого документа (параметр -s) Pandoc выводит данные в шаблон. Для каждого выходного формата шаблоны разные. Чтобы посмотреть шаблон используйте команду

Например

Читать далее Шаблоны и переменные Pandoc

Способы добавления метаданных в документ Pandoc

Pandoc позволяет добавить метеоданные к документу несколькими способами. Рассмотрим три из них:

  1. Параметры;
  2. YAML блок;
  3. Файл с метаданными.

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

Файл с метаданными

Файл с метаданными, это обычный yaml файл, такой как metadata.yaml:

При запуске имя файла передаётся в параметре --metadata-file:

Читать далее Способы добавления метаданных в документ Pandoc

Опции Pandoc: file-scope, preserve-tabs, tab-stop

Рассмотрим несколько параметров Pandoc. Все примеры зафиксированы в репозитории.

file-scope

Существует два способа конвертации одного документа из нескольких файлов:

  • сначала соединить все файлы в один, а потом конвертировать
  • конвертировать все файлы по отдельности, а потом соединить.

По умолчанию Pandoc использует первый вариант.

Например, если отдельные файлы будут содержать дублирующиеся номера примечаний то Pandoc выдаст предупреждение.

Читать далее Опции Pandoc: file-scope, preserve-tabs, tab-stop

Отладка ошибок конвертации в Pandoc

Рассмотрим способы получения информации об ошибка при конвертации файлов через Pandoc. Все примеры расположены в репозитории.

Попробуем конвертировать md-файл в html:

Появляется предупреждение:

Файл всё равно будет конвертирован. Причем pandoc завершит работу без кода ошибки. Если нужно чтобы в случае предупреждения код ошибки был не равен 0, то используйте команду --fail-if-warnings:

Результатом будет:

Код ошибки 3 — специальный код ошибки для предупреждений.

Читать далее Отладка ошибок конвертации в Pandoc

Основы Pandoc

Pandoc конвертирует текстовые файлы из одних форматов в другие. Рассмотрим его базовые команды.

Все примеры расположены в репозитории.

Конвертация

Pandoc является обычным консольным приложением и принимает команды стандартным образом.

По умолчанию Pandoc принимает данные для конвертации из входного потока и отправляет во выходной поток. Чтобы определить исходный файл передайте ему имя файла:

Читать далее Основы Pandoc

Конвертация Markdown в doc через Pandoc с переопределением стилей

Pandoc преобразовывает текстовые файлы из одних форматов в другие. При преобразовании из формата который содержит меньше возможностей для форматирования в формат с большими возможностями появляется необходимость уточнения стилей для более богатого формата. Примером такой конвертации является преобразования Markdown в doc при которой используется дополнительный doc-файл со стилями.

Пример

Исходный md-файл:

Дополним команду для конвертации параметром --reference-doc и передадим в него имя файла со стиялми:

Файл custom-styles.docx это обычный файл Word с определёнными набором стилей.

Читать далее Конвертация Markdown в doc через Pandoc с переопределением стилей