Configure a pkgdown site with rogtemplate

Add the rOpenGov template configuration to your _pkgdown.yml. If no configuration file exists, create one at pkgdown/_pkgdown.yml. Also add the corresponding paths to .Rbuildignore.

Usage

rog_add_template_pkgdown()

Value

The function is called for its side effects and returns invisible(NULL).

Details

The function also adds the package website URL (https://ropengov.github.io/pkgname/) and repository URL (https://github.com/rOpenGov/pkgname) to _pkgdown.yml and DESCRIPTION if they are not already present.

See also

The pkgdown vignettes vignette("pkgdown", package = "pkgdown") and vignette("linking", package = "pkgdown"). See also usethis's usethis::use_tidy_description().

Site setup helpers: rog_actions_pkgdown_branch(), rog_build()

Examples

# \dontrun{
rog_add_template_pkgdown()
#> Error: No DESCRIPTION file found.
# }