build_vignettes • pkgsite

build_vignettes {pkgsite}

R Documentation

Build vignettes section

Description

build_vignettes() renders R Markdown files from vignettes/ to vignettes/

Usage

build_vignettes(pkg = ".", lazy = FALSE, quiet = FALSE, preview = FALSE)

build_vignettes_index(pkg = ".")

Arguments

pkg Path to package

lazy Whether to skip files that haven't changed

quiet Whether to suppress messages

preview Whether to preview after building using a local server (requires the servr package)

Value

Invisible TRUE if the vignettes were built successfully

Examples

## Not run:
build_vignettes()

# Rebuild only if source is newer than destination
build_vignettes(lazy = TRUE)

# Hide build messages
build_vignettes(quiet = TRUE)

# Preview the vignettes index after building
build_vignettes(preview = TRUE)

## End(Not run)