Preview one pkgdown article without publishing the site — pkgdown_preview_article • EJAM

Preview one pkgdown article without publishing the site

Usage

pkgdown_preview_article(
  article,
  pkg = ".",
  destination = file.path(tempdir(), "EJAM-pkgdown-preview"),
  preview = interactive(),
  clean = FALSE,
  lazy = FALSE,
  quiet = FALSE
)

Arguments

article: Article name such as "installing" or a path such as "vignettes/installing.Rmd".
pkg: Package root.
destination: Local output folder. Defaults to a temporary preview folder so source branches do not accumulate generated HTML.
preview: Open the rendered article in a browser?
clean: Delete the preview folder before rendering?
lazy: Passed to pkgdown::build_article().
quiet: Passed to pkgdown::build_article().

Value

The rendered article HTML path, invisibly.