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

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

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

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

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

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

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

title: Заголовок metadata-file
1

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

pandoc -o output.html -f markdown -t html -s --metadata-file=metadata.yaml input01.md
1

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

YAML блок

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

---
title: Заголовок YAML-блок
---
1
2
3

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

pandoc -o output.html -f markdown -t html -s --metadata-file=metadata.yaml input02.md
1

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

Параметры

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

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

Например

pandoc -o output.html -f markdown -t html -s --metadata-file=metadata.yaml -M "title=Заголовок параметры" input01.md
1
Последниее изменение: 31.08.2021, 15:52:51