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

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

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

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

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

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

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

После запуска в документе появится html заголовок h1, хотя в документе MD не было заголовка первого уровня.

YAML блок

Блок YAML записывается внутрь исходного MD файла, в следующем формате:

Команда запуска не меняется:

Заголовок будет выведен из блока YAML в MD файле, а не из отдельного файла метаданных.

Параметры

Метаданные можно передать через параметры запуска Pandoc, они более приоритетные, чем YAML блок и файл метаданных. Для передачи параметров используются конструкции:

  • -M KEY[=VAL]
  • --metadata=KEY[:VAL]

Например

Если вы нашли ошибку, пожалуйста, выделите фрагмент текста и нажмите Ctrl+Enter.

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *