Description Usage Arguments Value Note
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.
1 2 3 4 5 6 7 8 9 | 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(...)
|
toc, number_sections, fig_caption, lib_dir, template, pandoc_args |
See
|
... |
Other arguments to be passed to |
base_format |
An output format function to be used as the base format. |
split_bib |
Whether to split the bibliography onto separate pages where the citations are actually used. |
page_builder |
A function to combine different parts of a chapter into a
page (an HTML character vector). See |
split_by |
How to name the HTML output files from the book: |
An R Markdown output format object to be passed to
bookdown::render_book()
.
These functions are expected to be used in conjunction with
render_book()
. It is almost meaningless if they are used with
rmarkdown::render()
. Functions like html_document2
are
designed to work with the latter.
If you want to use a different template, the template must contain three
pairs of HTML comments: <!--bookdown:title:start--> and
<!--bookdown:title:end--> to mark the title section of the book
(this section will be placed only on the first page of the rendered book);
<!--bookdown:toc:start--> and <!--bookdown:toc:end--> to mark
the table of contents section (it will be placed on all chapter pages);
<!--bookdown:body:start--> and <!--bookdown:body:end--> to
mark the HTML body of the book (the HTML body will be split into separate
pages for chapters). You may open the default HTML template
(bookdown:::bookdown_file('templates/default.html')
) to see where
these comments were inserted.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.