--s, --standalone

    生成包含适当页眉和页脚的输出(例如独立的 HTML、LaTeX、TEI 或 RTF 文件,而不是片段)。此选项对于 pdf、epub、epub3、fb2、docx 和 odt 输出会自动设置。对于原生输出,此选项会导致包含元数据;否则,将抑制元数据。

    --template=FILE|URL

    使用指定的文件作为生成文档的自定义模板。隐含 —standalone。有关模板语法的描述,请参见下面的模板。如果未指定扩展名,则将添加与编写器相对应的扩展名,因此 —template=special 会在 HTML 输出中查找 special.html。如果未找到模板,pandoc 将在用户数据目录的 templates 子目录中搜索它(参见 —data-dir)。如果不使用此选项,则将使用适用于输出格式的默认模板(参见 -D/—print-default-template)。

    -V KEY[=VAL], --variable=KEY[:VAL]

    在独立模式下呈现文档时,将模板变量 KEY 设置为值 VAL。如果未指定 VAL,则该键将赋予值 true。

    --sandbox[=true|false]

    在沙盒中运行 pandoc,将读者和写者的 IO 操作限制为读取命令行指定的文件。请注意,此选项不会限制过滤器的 IO 操作或生成 PDF 文档的操作。但它确实提供了安全性,例如通过使用 include 指令披露文件的安全性。在使用 pandoc 处理不受信任的用户输入时,应使用此选项。

    注意:某些读者和写者(例如,docx)需要访问数据文件。如果这些文件存储在文件系统上,那么在 —sandbox 模式下运行 pandoc 时将无法找到它们,并将引发错误。对于这些应用程序,建议使用启用了 embed_data_files 选项的 pandoc 二进制文件,该选项会导致数据文件嵌入到二进制文件中,而不是存储在文件系统上。

    -D FORMAT, --print-default-template=FORMAT

    打印输出格式 FORMAT 的系统默认模板。(参见 -t 获取可能的 FORMAT 列表。)用户数据目录中的模板将被忽略。此选项可与 -o/—output 一起使用,以将输出重定向到文件,但 -o/—output 必须在命令行上的 —print-default-template 之前。

    请注意,某些默认模板使用部分模板,例如 styles.html。要打印部分,请使用 —print-default-data-file,例如 —print-default-data-file=templates/styles.html。

    --print-default-data-file=FILE

    打印系统默认数据文件。用户数据目录中的文件将被忽略。此选项可与 -o/—output 一起使用,以将输出重定向到文件,但 -o/—output 必须在命令行上的 —print-default-data-file 之前。

    --eol=crlf|lf|native

    手动指定换行符:crlf(Windows)、lf(macOS/Linux/UNIX)或 native(适用于运行 pandoc 的操作系统的换行符)。默认值为 native。

    --dpi=NUMBER

    指定从像素到英寸/厘米的转换的默认 dpi(每英寸的点数)。(从技术上讲,正确的术语应该是 ppi:每英寸像素数。)默认值为 96dpi。当图像内部包含关于 dpi 的信息时,将使用编码的值,而不是此选项指定的默认值。

    --wrap=auto|none|preserve

    确定如何在输出中(源代码而不是呈现的版本)换行。使用 auto(默认)时,pandoc 将尝试将行包装到由 —columns 指定的列宽中(默认为 72)。使用 none 时,pandoc 将完全不包装行。使用 preserve 时,pandoc 将尝试保留源文档中的换行(也就是说,在源文档中存在非语义换行符的地方,输出中也将存在非语义换行符)。在 ipynb 输出中,此选项影响 markdown 单元格内容的换行。

    --columns=NUMBER

    指定以字符为单位的行长度。这影响生成的源代码的文本换行(参见 —wrap)。它还影响纯文本表格的列宽计算(参见下面的 Tables)。

    --toc[=true|false], --table-of-contents[=true|false]

    在输出文档中包含自动生成的目录(或在 latex、context、docx、odt、opendocument、rst 或 ms 中,包含创建目录的指令)。此选项仅在使用 -s/—standalone 时才生效,并且对于 man、docbook4、docbook5 或 jats 输出没有影响。

    请注意,如果通过 ms 生成 PDF,则目录将出现在文档标题之前。如果希望它出现在文档末尾,请使用选项 —pdf-engine-opt=—no-toc-relocation。

    --toc-depth=NUMBER

    指定目录中包含的部分级别数。默认值为 3(这意味着将列出级别为 1、2 和 3 的标题内容)。

    --strip-comments[=true|false]

    从 Markdown 或 Textile 源中剥离 HTML 注释,而不是将它们作为原始 HTML 传递给 Markdown、Textile 或 HTML 输出。当 markdown_in_html_blocks 扩展未设置时,这不适用于原始 HTML 块中的 HTML 注释。

    --no-highlight

    禁用代码块和内联元素的语法高亮,即使给定了语言属性也是如此。

    --highlight-style=STYLE|FILE

    指定用于突出显示源代码的着色样式。选项有 pygments(默认)、kate、monochrome、breezeDark、espresso、zenburn、haddock 和 tango。有关 pandoc 中语法高亮的更多信息,请参见下文的 Syntax highlighting。另请参阅 —list-highlight-styles。

    可以提供扩展名为 .theme 的 JSON 文件,而不是 STYLE 名称。这将被解析为 KDE 语法高亮主题,并且(如果有效)将用作着色样式。

    要生成现有样式的 JSON 版本,请使用 —print-highlight-style。

    --print-highlight-style=STYLE|FILE

    打印着色样式的 JSON 版本,可以修改、保存为 .theme 扩展名并与 —highlight-style 一起使用。此选项可与 -o/—output 一起使用,以将输出重定向到文件,但 -o/—output 必须在命令行上的 —print-highlight-style 之前。

    --syntax-definition=FILE

    指示 pandoc 加载 KDE XML 语法定义文件,该文件将用于适当标记的代码块的语法高亮。这可用于为新语言添加支持或使用现有语言的更改语法定义。此选项可重复使用以添加多个语法定义。

    -H FILE, --include-in-header=FILE|URL

    在页眉的末尾,逐字包含 FILE 的内容。例如,在 HTML 文档中包含特殊的 CSS 或 JavaScript 可以使用此选项。此选项可重复使用,以逐字包含页眉中的多个文件。它们将按指定的顺序包含。隐含 —standalone。

    -B FILE, --include-before-body=FILE|URL

    在文档正文的开头(例如在 HTML 中的 标签之后,或在 LaTeX 中的 \begin{document} 命令之后)逐字包含 FILE 的内容。这可用于在 HTML 文档中包含导航栏或横幅。此选项可重复使用,以逐字包含正文前的多个文件。它们将按指定的顺序包含。隐含 —standalone。

    -A FILE, --include-after-body=FILE|URL

    在文档正文的末尾(在 HTML 中的 标签之前,或在 LaTeX 中的 \end{document} 命令之前)逐字包含 FILE 的内容。此选项可重复使用,以逐字包含正文后的多个文件。它们将按指定的顺序包含。隐含 —standalone。

    --resource-path=SEARCHPATH

    要搜索图像和其他资源的路径列表。在 Linux、UNIX 和 macOS 系统上,路径应以 : 分隔,在 Windows 上应以 ; 分隔。如果未指定 —resource-path,则默认资源路径为工作目录。请注意,如果指定了 —resource-path,则必须显式列出工作目录,否则将不会搜索它。例如:—resource-path=.:test 将搜索工作目录和 test 子目录,按照指定的顺序。此选项可重复使用。在命令行上后面的搜索路径组件将在先前的路径组件之前搜索,因此 —resource-path foo:bar —resource-path baz:bim 等效于 —resource-path baz:bim:foo:bar。

    --request-header=NAME:VAL

    在进行 HTTP 请求(例如,在命令行上给出 URL 或必须下载文档中使用的资源时)时,将请求头 NAME 设置为值 VAL。如果在代理后面,还需要将环境变量 http_proxy 设置

    http://....。

    --no-check-certificate[=true|false]

    禁用证书验证,以允许访问不安全的 HTTP 资源(例如当证书不再有效或为自签名证书时)。