Preview the pkgdown site locally without publishing it

Usage

pkgdown_preview_site(
  pkg = ".",
  destination = file.path(tempdir(), "EJAM-pkgdown-preview"),
  pkgdown_dev_mode = c("release", "devel"),
  preview = interactive(),
  clean = FALSE,
  lazy = TRUE,
  quiet = FALSE
)

Arguments

pkg: Package root.
destination: Local output folder. Defaults to a temporary preview folder so source branches do not accumulate generated HTML.
pkgdown_dev_mode: Use "release" for the main site or "devel" for the development site under dev/.
preview: Open the rendered site in a browser?
clean: Delete the preview folder before rendering?
lazy: Passed to pkgdown::build_site().
quiet: Passed to pkgdown::build_site().

Value

The rendered site index path, invisibly.