add the custom-environment.lua filter in common_format_config() instead of doing it for every single output format; this also make sure we won't need to do extra work in the future to support custom environments in other formats like Word and EPUB

Author: yihui

R/gitbook.R

@@ -34,16 +34,11 @@ gitbook = function(
   if (identical(template, 'default')) {
     template = bookdown_file('templates', 'gitbook.html')
   }
-
   config = html_document2(
     toc = TRUE, number_sections = number_sections, fig_caption = fig_caption,
     self_contained = self_contained, lib_dir = lib_dir, theme = NULL,
     template = template, pandoc_args = pandoc_args2(pandoc_args), ...
   )
-
-  # add custom environment lua filter
-  config = add_custom_environment_args(config)
-
   split_by = match.arg(split_by)
   post = config$post_processor  # in case a post processor have been defined
   config$post_processor = function(metadata, input, output, clean, verbose) {

R/html.R

@@ -54,16 +54,11 @@ html_chapters = function(
   base_format = rmarkdown::html_document, split_bib = TRUE, page_builder = build_chapter,
   split_by = c('section+number', 'section', 'chapter+number', 'chapter', 'rmd', 'none')
 ) {
-
   config = get_base_format(base_format, list(
     toc = toc, number_sections = number_sections, fig_caption = fig_caption,
     self_contained = FALSE, lib_dir = lib_dir,
     template = template, pandoc_args = pandoc_args2(pandoc_args), ...
   ))
-
-  # add custom environment lua filter
-  config = add_custom_environment_args(config)
-
   split_by = match.arg(split_by)
   post = config$post_processor  # in case a post processor have been defined
   config$post_processor = function(metadata, input, output, clean, verbose) {
@@ -130,14 +125,9 @@ tufte_html_book = function(...) {
 html_document2 = function(
   ..., number_sections = TRUE, pandoc_args = NULL, base_format = rmarkdown::html_document
 ) {
-
   config = get_base_format(base_format, list(
     ..., number_sections = number_sections, pandoc_args = pandoc_args2(pandoc_args)
   ))
-
-  # add custom environment lua filter
-  config = add_custom_environment_args(config)
-
   post = config$post_processor  # in case a post processor have been defined
   config$post_processor = function(metadata, input, output, clean, verbose) {
     if (is.function(post)) output = post(metadata, input, output, clean, verbose)

R/latex.R

@@ -36,15 +36,10 @@ pdf_book = function(
   base_format = rmarkdown::pdf_document, toc_unnumbered = TRUE,
   toc_appendix = FALSE, toc_bib = FALSE, quote_footer = NULL, highlight_bw = FALSE
 ) {
-
   config = get_base_format(base_format, list(
     toc = toc, number_sections = number_sections, fig_caption = fig_caption,
     pandoc_args = pandoc_args2(pandoc_args), ...
   ))
-
-  # add custom environment lua filter
-  config = add_custom_environment_args(config)
-
   config$pandoc$ext = '.tex'
   post = config$post_processor  # in case a post processor have been defined
   config$post_processor = function(metadata, input, output, clean, verbose) {

R/utils.R

@@ -32,6 +32,13 @@ common_format_config = function(
   # provide file_scope if requested
   if (file_scope) config$file_scope = md_chapter_splitter
 
+  # prepend the custom-environment filter
+  config$pandoc$lua_filters = c(
+    lua_filter("custom-environment.lua"), config$pandoc$lua_filters
+  )
+  # and add bookdown metadata file for the filter to work
+  config$pandoc$args = c(bookdown_yml_arg(), config$pandoc$args)
+
   # set output format
   config$bookdown_output_format = format
 
@@ -573,20 +580,6 @@ bookdown_yml_arg = function(config = load_config(), path = tempfile()) {
   c("--metadata-file", rmarkdown::pandoc_path_arg(path))
 }
 
-# add custom environment filter to a format
-add_custom_environment_args = function(format) {
-  if (!inherits(format, "rmarkdown_output_format"))
-    stop("format should be a rmarkdown output format.")
-  # prepend the filter
-  format$pandoc$lua_filters = c(
-    lua_filter("custom-environment.lua"), format$pandoc$lua_filters
-  )
-  # and add bookdown metadata file for the filter to work
-  format$pandoc$args = c(bookdown_yml_arg(), format$pandoc$args)
-  # return the modified format
-  format
-}
-
 #' Convert the syntax of theorem and proof environments from code blocks to
 #' fenced Divs
 #'