build_lesson | R Documentation |
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 |
quiet |
when |
preview |
if |
override |
options to override (e.g. building to alternative paths). This is used internally and will likely be changed. |
A Carpentries Workbench lesson is comprised of a set of markdown files and folders:
+-- config.yaml +-- index.md +-- episodes | +-- data | +-- fig | +-- files | \-- introduction.Rmd +-- instructors | \-- instructor-notes.md +-- learners | \-- setup.md +-- profiles | \-- learner-profiles.md +-- links.md +-- site \-- [...] +-- renv | \-- [...] +-- CODE_OF_CONDUCT.md +-- CONTRIBUTING.md +-- LICENSE.md \-- README.md
TRUE
if it was successful, a character vector of issues if it was
unsuccessful.
serve()
: an interactive way to build and edit lesson content.
tmp <- tempfile() create_lesson(tmp, open = FALSE) create_episode("first-script", path = tmp) check_lesson(tmp) build_lesson(tmp)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.