build_html | R Documentation |
Build instructor and learner HTML page
build_html(
template = "chapter",
pkg,
nodes,
global_data,
path_md,
quiet = TRUE
)
template |
the name of the |
pkg |
an object created from |
nodes |
an |
global_data |
a list store object that contains copies of the global
variables for the page, including metadata, navigation, and variables for
the |
path_md |
the path (absolute, relative, or filename) the current markdown file being processed. |
quiet |
This parameter is passed to |
This function is a central workhorse that connects the global
lesson metadata and the global variables for each page to the rendering
engine: {pkgdown}
. It will perform the global operations that includes
setting up the navigation (via update_sidebar()
), adding metadata, and
building both the instructor and learner versions of the page (via
pkgdown::render_page()
).
In the Workbench, there are three types of pages:
primary content pages: these are primary content with a 1:1 relationship between the source and the output. These are episodes along with custom learner and instructor content
aggregate content pages: pages that are aggregated from other pages such as key points, all-in-one, images
concatenated content pages: concatenations of source files and potentially aggregate data. Examples are index, learner profiles, and the instructor notes pages.
Each of these types of pages have their own process for setting up content, which gets processed before its passed here.
TRUE
if the page was built and NULL
if it did not need to be
rebuilt
set_globals()
for definitions of the global data,
update_sidebar()
for context of how the sidebar is updated,
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.