build_lesson: Build your lesson site
In zkamvar/sandpaper: Create and Curate Carpentries Lessons

Description Usage Arguments Value Examples

This function orchestrates rendering generated lesson content and applying the theme for the HTML site.

build_lesson(
  path = ".",
  rebuild = FALSE,
  quiet = !interactive(),
  preview = TRUE,
  override = list()
)

`path`	the path to your repository (defaults to your current working directory)
`rebuild`	if `TRUE`, everything will be built from scratch as if there was no cache. Defaults to `FALSE`, which will only build markdown files that haven't been built before.
`quiet`	when `TRUE`, output is supressed
`preview`	if `TRUE`, the rendered website is opened in a new window
`override`	options to override (e.g. building to alternative paths). This is used internally and will likely be changed.

TRUE if it was successful, a character vector of issues if it was unsuccessful.

tmp <- tempfile()
create_lesson(tmp, open = FALSE)
create_episode("first-script", path = tmp)
check_lesson(tmp)
if (rmarkdown::pandoc_available("2.11"))
  build_lesson(tmp)