Document YAML Options
The quarto-live
extension can be configured using YAML options. There are three main option keys of interest: webr
, pyodide
and live
.
For a single document, the config options can be set at the top level in your document’s YAML front matter. For Quarto projects, the options should be set under the live-
format key to ensure that Quarto’s project-level metadata merging is successful.
Options Reference
webr
YAML Key | Type | Description |
---|---|---|
cell-options |
Object | Code cell options to be applied to all webr blocks in the document. |
engine-url |
String | URL from which to load the webR WebAssembly engine, e.g. https://repo.r-wasm.org/v0.4.0/ . |
packages |
Array | List of R packages to install automatically. |
render-df |
String | Method used to render data.frame objects. |
repos |
Array | List of CRAN-like repos from which to install R packages. |
resources |
Array | Resources to be loaded into the webR VFS. Defaults to all resources. |
pyodide
YAML Key | Type | Description |
---|---|---|
cell-options |
Object | Code cell options to be applied to all pyodide blocks in the document. |
engine-url |
String | URL from which to load the Pyodide WebAssembly engine, e.g. https://cdn.jsdelivr.net/pyodide/v0.26.1/full/ . |
packages |
Array | List of Python packages to install automatically. |
resources |
Array | Resources to be loaded into the Pyodide VFS. Defaults to all resources. |
live
YAML Key | Type | Description |
---|---|---|
show-hints |
Boolean | Include exercise hints in document output. |
show-solutions |
Boolean | Include exercise solutions in document output. |
show-grading |
Boolean | Include exercise grading in document output. |
Example
A fully-configured document might look something like this:
live-document.qmd
---
title: An Example
format:
live-html:
webr:
packages:
- ggplot2
- mypackage
repos:
- https://myrepo.example.com/
pyodide:
cell-options:
edit: false
packages:
- matplotlib
live:
show-solutions: false
resources: datadir
---