build_lesson: Build your lesson site

Description Usage Arguments Value Examples

View source: R/build_lesson.R

Description

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

Usage

1
2
3
4
5
6
7
build_lesson(
  path = ".",
  rebuild = FALSE,
  quiet = !interactive(),
  preview = TRUE,
  override = list()
)

Arguments

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.

Value

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

Examples

1
2
3
4
5
6
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)

zkamvar/sandpaper documentation built on Nov. 25, 2021, 1:16 p.m.