yaml - 我可以使用 pandoc 中的 YAML header 选项控制什么？

Question

我只是偶然看到一个示例文档，该文档在由 Pandoc 处理的 Markdown 文件中的 YAML header 选项中使用了 toc: true 行。还有Pandoc docs没有提到使用 YAML header 控制目录的选项。此外，我在同一个 Pandoc 自述网站上的示例文档中看到了一些任意的行。

主要问题:

• 使用 YAML header 可以使用哪些 Pandoc 选项？

元问题:

• 什么决定了可使用 YAML header 设置的可用 Pandoc 选项？

注意:我的工作流程是使用 Markdown 文件(.md)并通过 Pandoc 处理它们以获取 PDF 文件。它用数学来分层组织手稿写作。如:

pandoc --standalone --smart \
    --from=markdown+yaml_metadata_block \
    --filter pandoc-citeproc \
    my_markdown_file.md \
    -o my_pdf_file.pdf

Answer 1

几乎 YAML 元数据中设置的所有内容都仅通过 pandoc template 起作用。使用中。

Pandoc 模板可能包含变量。例如，在 HTML 模板中，您可以编写:

<title>$title$</title>

这些模板变量可以使用 --variable KEY[=VAL] 设置选项。

但是，它们也是从文档元数据设置的，而文档元数据又可以通过使用以下方式设置:

• --metadata KEY[=VAL]选项，
• 一个YAML metadata block ，或
• --metadata-file选项。

--variable options 将字符串逐字插入模板中，而 --metadata转义字符串。 YAML 元数据中的字符串(也在使用 --metadata-file 时)被解释为 markdown，您可以通过使用 pandoc markdown 的 generic raw attributes 来规避这种情况。 。例如 HTML 输出:

`<script>alert()</script>`{=html}

查看此table for a schematic :

<表类=“s-表”><标题>--变量--元数据YAML 元数据和 --metadata-file <正文>值可以是...字符串和 bool 值字符串和 bool 值还有 YAML 对象和列表字符串是...逐字插入逃脱解释为 Markdown 可通过过滤器访问:没有是是

回答您的问题:模板确定 YAML 元数据 block 中的哪些字段有效。例如，要查看默认的 Latex 模板，请使用:

$ pandoc -D latex

要查看 pandoc 自动设置的一些变量，see the Manual 。最后，pandoc的其他行为(例如markdown扩展等)只能设置为命令行选项(使用 wrapper script 时除外)。