rmarkdown (version 2.28)

pandoc_args: Functions for generating pandoc command line arguments

Description

Functions that assist in creating various types of pandoc command line arguments (e.g. for templates, table of contents, highlighting, and content includes).

Usage

pandoc_variable_arg(name, value)
pandoc_metadata_arg(name, value)
pandoc_metadata_file_arg(file)
pandoc_include_args(in_header = NULL, before_body = NULL, after_body = NULL)
pandoc_highlight_args(highlight, default = "tango")
pandoc_latex_engine_args(latex_engine)
pandoc_toc_args(toc, toc_depth = 3)
pandoc_citeproc_args()
pandoc_lua_filter_args(lua_files)

Value

A character vector with pandoc command line arguments.

Arguments

name

Name of template variable to set.

value

Value of template variable (defaults to true if missing).

file

string. Path to a file

in_header

One or more files with content to be included in the header of the document.

before_body

One or more files with content to be included before the document body.

after_body

One or more files with content to be included after the document body.

highlight

The name of a pandoc syntax highlighting theme.

default

The highlighting theme to use if "default" is specified.

latex_engine

LaTeX engine for producing PDF output. Options are "pdflatex", "lualatex", "xelatex", and "tectonic".

toc

TRUE to include a table of contents in the output.

toc_depth

Depth of headers to include in table of contents.

lua_files

Character vector of file paths to Lua filter files. Paths will be transformed by pandoc_path_arg.

About Pandoc citeproc

For Pandoc version before 2.11, a pandoc filter pandoc-citeproc is used. Since Pandoc 2.11, the feature is built-in and activated using --citeproc flag. pandoc_citeproc_arg will return the correct switches depending on the Pandoc version in use.

Details

Non-absolute paths for resources referenced from the in_header, before_body, and after_body parameters are resolved relative to the directory of the input document.

Examples

if (FALSE) {
library(rmarkdown)

pandoc_include_args(before_body = "header.htm")
pandoc_include_args(before_body = "header.tex")

pandoc_highlight_args("kate")

pandoc_latex_engine_args("pdflatex")

pandoc_toc_args(toc = TRUE, toc_depth = 2)
}