Description Usage Arguments YAML config
View source: R/build-tutorials.R
learnr tutorials must be hosted elsewhere as they require an
R execution engine. Currently, pkgdown will not build or publish tutorials
for you, but makes it easy to embed (using <iframe>
s) published tutorials.
Tutorials are automatically discovered from published tutorials in
inst/tutorials
and vignettes/tutorials
. Alternatively, you can
list in _pkgdown.yml
as described below.
1 | build_tutorials(pkg = ".", override = list(), preview = NA)
|
pkg |
Path to package. |
override |
An optional named list used to temporarily override
values in |
preview |
If |
To override the default discovery process, you can provide a tutorials
section. This should be a list where each element specifies:
name
: used for the generated file name
title
: used in page heading and in navbar
url
: which will be embedded in an iframe
source
: optional, but if present will be linked to
1 2 3 4 5 6 7 |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.