Skip to contents

Authoring tutorials

Scaffold and run interactive tutorials.

create_tutorial()
Create a new learnr2 tutorial
tutorial_options()
Set tutorial-wide options
run_tutorial()
Run a bundled tutorial
prerender_tutorials()
Render every installed Quarto tutorial into the cache
available_tutorials()
List tutorials bundled with learnr2 (or any installed package)
show_file()
Display all or part of a text file

Testing tutorials

Confirm tutorials render and follow the authoring rules.

render_tutorials()
Render tutorials, as a test that they build
check_tutorial()
Check that a tutorial has the recommended components

Quiz questions

learnr-style quiz questions, graded in the browser.

question()
Create a quiz question
answer()
Define an answer choice for a quiz question
quiz()
Group questions into a quiz

Collecting student work

Gather reader identifying information and let them turn work in.

student_info()
Collect student identifying information
download_answers_button()
Add a "download my answers" button
submission_time()
Recover a submission's download time

Quarto-live extension

Manage the bundled quarto-live Quarto extension.

add_live_extension()
Add the 'quarto-live' extension to a project
live_extension_dir()
Path to the bundled 'quarto-live' extension