build_site {pkgsite}R Documentation

Build a minimal pkgdown website

Description

build_site() creates a simple static documentation site with:

  • init_site()

  • build_home()

  • build_reference()

  • build_vignettes()

The site uses a minimal template with a simple sidebar navigation.

Usage

build_site(pkg = ".", lazy = FALSE, preview = FALSE, quiet = TRUE, url = NULL)

Arguments

pkg Path to package
lazy If TRUE, will only rebuild if source is newer than destination
preview Whether to preview the site after building using a local server (requires the servr package)
quiet Whether to suppress build messages
url Optional URL for the site, used to create CNAME file (e.g., useful for GitHub Pages)

Value

Invisible TRUE if the site was built successfully

Examples

## Not run:
build_site()

# Preview the site after building
build_site(preview = TRUE)

# Specify a URL to create a CNAME file
build_site(url = "yourdomain.com")

# Only rebuild if source is newer than destination
build_site(lazy = TRUE)

## End(Not run)

Loading...