Pandoc options for an output format

Source: R/output_format.R

Define the pandoc options for an R Markdown output format.

pandoc_options(
  to,
  from = rmarkdown_format(),
  args = NULL,
  keep_tex = FALSE,
  latex_engine = c("pdflatex", "lualatex", "xelatex", "tectonic"),
  ext = NULL,
  lua_filters = NULL,
  convert_fun = NULL
)

Arguments

to

Pandoc format to convert to

from

Pandoc format to convert from

args

Character vector of command line arguments to pass to pandoc

keep_tex

Keep the intermediate tex file used in the conversion to PDF (applies only to 'latex' and 'beamer' target formats)

latex_engine

LaTeX engine to producing PDF output (applies only to 'latex' and 'beamer' target formats)

ext

File extension (e.g. ".tex") for output file (if NULL chooses default based on to). This is typically used to force the final output of a latex or beamer conversion to be .tex rather than .pdf.

lua_filters

Character vector of file paths to Lua filters to use with this format. They will be added to pandoc command line call using --lua-filter argument. See vignette("lua-filters", package = "rmarkdown") to know more about Lua filters.

convert_fun

A function to convert the input file to the desired output format in render(). If not provided, pandoc_convert() will be used. If a custom function is provided, its arguments and returned value should match the pandoc_convert() function. Note that this function does not have to use Pandoc but can also use other tools such as commonmark.

Value

An list that can be passed as the pandoc argument of the output_format function.

Details

The from argument should be used very cautiously as it's important for users to be able to rely on a stable definition of supported markdown extensions.