R/writeMDX.R

Defines functions writeMDX

Documented in writeMDX

#' @importFrom rmarkdown render
#' @importFrom strex str_after_first str_after_last str_before_first
#' @title writeMDX
#' @description write and Rmarkdown (.Rmd) file to MDX (.mdx) format.
#' @param input Input file (.Rmd format).
#' @param config \code{list}. Configurable YAML fields to check for. Default is
#' config = list("date", "title", "featuredImage")
#' @examples
#' \dontrun{
#' # supposing you have a 'test.Rmd' file:
#' writeMDX("test.Rmd")
#' }
#' @export
writeMDX <- function(input,
                     config = list(
                       include = list("date", "title", "featuredImage"),
                       exclude = list("author", "output")
                     )) {
  if (tools::file_ext(input) != "Rmd") stop("This only works with Rmarkdown files (.Rmd).")
  rmarkdown::render(input, mdx_format(cfig = config))
}
RobertMyles/writeMDx documentation built on March 4, 2020, 1:32 p.m.