This unlinks the docs subdirectory, runs devtools document function, and writes a new docs/ directory using the pkgdown build_site function.

deploy_gh_pages(
  commit_msg = "deploy GitHub Pages using glitter",
  remote_name = "origin",
  remote_branch = "master",
  path = getwd(),
  examples = TRUE,
  run_dont_run = FALSE,
  seed = 1014,
  lazy = TRUE,
  override = list(),
  preview = FALSE,
  devel = TRUE,
  new_process = !devel,
  install = !devel
)

Arguments

commit_msg

commit message

remote_name

name of remote to push to. Defaults to "origin".

remote_branch

name of branch on the remote to push to. Defaults to "master" or "main" if the cardinal branch is using this newer default.

path

full path to local repository to be pushed

examples

Run examples?

run_dont_run

Run examples that are surrounded in \dontrun?

seed

Seed used to initialize so that random examples are reproducible.

lazy

If TRUE, will only rebuild articles and reference pages if the source is newer than the destination.

override

An optional named list used to temporarily override values in _pkgdown.yml

preview

If TRUE, or is.na(preview) && interactive(), will preview freshly generated section in browser.

devel

Use development or deployment process?

If TRUE, uses lighter-weight process suitable for rapid iteration; it will run examples and vignettes in the current process, and will load code with pkgload::load_all().

If FALSE, will first install the package to a temporary library, and will run all examples and vignettes in a new process.

build_site() defaults to devel = FALSE so that you get high fidelity outputs when you building the complete site; build_reference(), build_home() and friends default to devel = TRUE so that you can rapidly iterate during development.

new_process

If TRUE, will run build_site() in a separate process. This enhances reproducibility by ensuring nothing that you have loaded in the current process affects the build process.

install

If TRUE, installs the package after the changes are pushed to the remote, Default: TRUE

See also