Pandoc позволяет добавить метеоданные к документу несколькими способами. Рассмотрим три из них:
- Параметры;
- YAML блок;
- Файл с метаданными.
Эти три способа могут применяться одновременно. В этом случае параметры будут перетирать друг друга. Начнем с самого низко-приоритетного файла с метаданными. Все примеры зафиксированы в репозитории.
Файл с метаданными
Файл с метаданными, это обычный yaml файл, такой как metadata.yaml:
|
1 |
title: Заголовок metadata-file |
При запуске имя файла передаётся в параметре --metadata-file:
|
1 |
pandoc -o output.html -f markdown -t html -s --metadata-file=metadata.yaml input01.md |
После запуска в документе появится html заголовок h1, хотя в документе MD не было заголовка первого уровня.
YAML блок
Блок YAML записывается внутрь исходного MD файла, в следующем формате:
|
1 2 3 |
--- title: Заголовок YAML-блок --- |
Команда запуска не меняется:
|
1 |
pandoc -o output.html -f markdown -t html -s --metadata-file=metadata.yaml input02.md |
Заголовок будет выведен из блока YAML в MD файле, а не из отдельного файла метаданных.
Параметры
Метаданные можно передать через параметры запуска Pandoc, они более приоритетные, чем YAML блок и файл метаданных. Для передачи параметров используются конструкции:
-M KEY[=VAL]--metadata=KEY[:VAL]
Например
|
1 |
pandoc -o output.html -f markdown -t html -s --metadata-file=metadata.yaml -M "title=Заголовок параметры" input01.md |
