yml_bookdown_opts | R Documentation |
bookdown uses YAML in three main places, as described in the bookdown book:
index.Rmd
, _output.yml
, and _bookdown.yml
. index.Rmd
can take most
YAML. _output.yml
is intended for output-related YAML, such as that
produced by yml() %>% yml_output(bookdown::pdf_book())
. _bookdown.yml
is
intended for configuring the build of the book. Pass the results of the
yml_*()
functions to use_index_rmd()
, use_bookdown_yml()
,
use_output_yml()
to write them to these files. yml_bookdown_site()
adds
the site: "bookdown::bookdown_site"
to the YAML metadata.
yml_bookdown_opts( .yml, book_filename = yml_blank(), delete_merged_file = yml_blank(), before_chapter_script = yml_blank(), after_chapter_script = yml_blank(), edit = yml_blank(), history = yml_blank(), rmd_files = yml_blank(), rmd_subdir = yml_blank(), output_dir = yml_blank(), clean = yml_blank(), ... ) yml_bookdown_site(.yml)
.yml |
a |
book_filename |
A character vector, the filename of the main |
delete_merged_file |
Logical. Delete the main |
before_chapter_script, after_chapter_script |
A character vector of one or more R scripts to be executed before or after each chapter |
edit |
A URL that collaborators can click to edit the |
history |
Similar to |
rmd_files |
A character vector, the order order of |
rmd_subdir |
whether to search for book source |
output_dir |
the output directory of the book ("_book" by default) |
clean |
a character vector of files and directories to be cleaned by the
|
... |
additional named R objects, such as characters or lists, to transform into YAML |
a yml
object
use_index_rmd()
use_bookdown_yml()
use_output_yml()
Other yml:
asis_yaml_output()
,
bib2yml()
,
draw_yml_tree()
,
has_field()
,
read_json()
,
use_yml_defaults()
,
use_yml_file()
,
use_yml()
,
yml_author()
,
yml_blogdown_opts()
,
yml_citations()
,
yml_clean()
,
yml_distill_opts()
,
yml_latex_opts()
,
yml_output()
,
yml_pagedown_opts()
,
yml_params()
,
yml_pkgdown()
,
yml_reference()
,
yml_replace()
,
yml_resource_files()
,
yml_rsconnect_email()
,
yml_rticles_opts()
,
yml_runtime()
,
yml_site_opts()
,
yml_toc()
,
yml_vignette()
Other bookdown:
gitbook_config()
yml_empty() %>% yml_bookdown_opts( book_filename = "my-book.Rmd", before_chapter_script = c("script1.R", "script2.R"), after_chapter_script = "script3.R", edit = "https =//github.com/rstudio/bookdown-demo/edit/master/%s", output_dir = "book-output", clean = c("my-book.bbl", "R-packages.bib") ) yml_empty() %>% yml_bookdown_opts( rmd_files = list( html = c("index.Rmd", "abstract.Rmd", "intro.Rmd"), latex = c("abstract.Rmd", "intro.Rmd") ) ) x <- yml_empty() %>% yml_title("A Minimal Book Example") %>% yml_date(yml_code(Sys.Date())) %>% yml_author("Yihui Xie") %>% yml_bookdown_site() %>% yml_latex_opts( documentclass = "book", bibliography = c("book.bib", "packages.bib"), biblio_style = "apalike" ) %>% yml_citations( link_citations = TRUE ) %>% yml_description("This is a minimal example of using the bookdown package to write a book.") x output_yml <- yml_empty() %>% yml_output( bookdown::gitbook( lib_dir = "assets", split_by = "section", config = gitbook_config(toolbar_position = "static") ), bookdown::pdf_book(keep_tex = TRUE), bookdown::html_book(css = "toc.css") ) output_yml
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.