build_quarto_site: Build Quarto Site

In jabenninghoff/rdev: R Development Tools

Build Quarto Site

Description

build_quarto_site() is a wrapper for quarto::quarto_render() that also updates README.md and optionally deletes the Quarto ⁠_freeze⁠ directory to fully re-render the site.

Usage

build_quarto_site(input = NULL, as_job = FALSE, unfreeze = FALSE, ...)

Arguments

input	The input file or project directory to be rendered (defaults to rendering the project in the current working directory).
as_job	Render as an RStudio background job. Default is "auto", which will render individual documents normally and projects as background jobs. Use the quarto.render_as_job R option to control the default globally.
unfreeze	If TRUE, delete the Quarto ⁠_freeze⁠ directory to fully re-render the site.
...	Arguments passed to quarto::quarto_render().

Details

When run, build_quarto_site() calls:

1. devtools::build_readme()

2. unfreeze() (if unfreeze = TRUE)

3. quarto::quarto_render()

Supported File Types

While build_quarto_site() supports both R Markdown (.Rmd) and Quarto (.qmd) notebooks in the analysis directory interchangeably, build_analysis_site() supports .Rmd files only.

jabenninghoff/rdev documentation built on Sept. 26, 2024, 10:37 p.m.