Add a pandoc_metadata_file_arg helper

It will be useful in rticles package
rstudio · Apr 17, 2023 · fce12fb · fce12fb
1 parent a0b1183
commit fce12fb
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Type: Package
 Package: rmarkdown
 Title: Dynamic Documents for R
-Version: 2.21.2
+Version: 2.21.3
 Authors@R: c(
     person("JJ", "Allaire", , "jj@posit.co", role = "aut"),
     person("Yihui", "Xie", , "xie@yihui.name", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-0645-5666")),

diff --git a/NEWS.md b/NEWS.md
@@ -1,6 +1,8 @@
 rmarkdown 2.22
 ================================================================================
 
+- Add a `pandoc_metadata_file_arg()` function to match Pandoc's CLI flag `--metadata-file`.
+
 - Mentions that **webshot** or **webshot2** is required to take screenshot of HTML widget. When not installed, an error message mentionning `always_allow_html: true` solution will be shown, but setting this is not the solution (quarto-dev/quarto-cli#4225).
 
 rmarkdown 2.21

diff --git a/R/pandoc.R b/R/pandoc.R
@@ -278,6 +278,13 @@ pandoc_metadata_arg <- function(name,
   c("--metadata", if (missing(value)) name else paste(name, "=", value, sep = ""))
 }
 
+#' @rdname pandoc_args
+#' @export
+pandoc_metadata_file_arg <- function(file) {
+
+  c("--metadata-file", pandoc_path_arg(file))
+}
+
 
 #' @rdname pandoc_args
 #' @export