Split the HTML output into chapters while updating relative links (e.g. links
in TOC, footnotes, citations, figure/table cross-references, and so on).
Functions html_book() and tufte_html_book() are simple wrapper
functions of html_chapter() using a specific base output format.
html_chapters(toc = TRUE, number_sections = TRUE, fig_caption = TRUE,
lib_dir = "libs", template = bookdown_file("templates/default.html"),
pandoc_args = NULL, ..., base_format = rmarkdown::html_document, split_bib = TRUE,
page_builder = build_chapter, split_by = c("section+number", "section",
"chapter+number", "chapter", "rmd", "none"))html_book(...)
tufte_html_book(...)
See
rmarkdown::html_document,
tufte::tufte_html, or the documentation of the
base_format function.
Other arguments to be passed to base_format. For
html_book() and tufte_html_book(), ... is passed to
html_chapters().
An output format function to be used as the base format.
Whether to split the bibliography onto separate pages where the citations are actually used.
A function to combine different parts of a chapter into a
page (an HTML character vector). See build_chapter for the
specification of this function.
How to name the HTML output files from the book: rmd
uses the base filenames of the input Rmd files to create the HTML
filenames, e.g. generate chapter1.html for chapter1.Rmd;
none means do not split the HTML file (the book will be a single
HTML file); chapter means split the file by the first-level headers;
section means the second-level headers. For chapter and
section, the HTML filenames will be determined by the header ID's,
e.g. the filename for the first chapter with a chapter title #
Introduction will be introduction.html; for chapter+number
and section+number, the chapter/section numbers will be prepended to
the HTML filenames, e.g. 1-introduction.html and
2-1-literature.html.
An R Markdown output format object to be passed to
bookdown::render_book().