Build your pkgdown site locally

A wrapper around pkgdown's pkgdown::build_site().

Usage

rog_build(pkg = ".", ...)

Arguments

pkg

Path to the package.

...

Arguments passed on to rog_logo, pkgdown::build_site

overwrite

Whether to overwrite the current logo. If FALSE and filename already exists, save the new logo to a temporary file instead.

favicons

Whether to create favicons with pkgdown's pkgdown::build_favicons() when filename is "man/figures/logo.png".

p_x

x position for package name

p_y

y position for package name

p_size

font size for package name

examples

Run examples?

preview

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

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, will install the package in a temporary library so it is available for vignettes.

Value

This function is called for its side effects and returns NULL invisibly.

Details

This function also calls rog_add_template_pkgdown() and rog_logo().

See also

rog_logo() for logo and favicon options, and pkgdown's pkgdown::build_site() for site build options.

Site setup helpers: rog_actions_pkgdown_branch(), rog_add_template_pkgdown()