build_home • pkgsite

build_home {pkgsite}

R Documentation

Build home section

Description

build_home() generates the home page from README.md or index.md

Usage

build_home(pkg = ".", quiet = FALSE, preview = FALSE)

build_home_index(pkg = ".", quiet = FALSE)

Arguments

pkg Path to package

quiet Whether to suppress messages

preview Whether to preview after building using a local server (requires the servr package)

Value

Invisible TRUE if the home page was built successfully

Examples

## Not run:
build_home()

# Hide build messages
build_home(quiet = TRUE)

# Preview the home page after building
build_home(preview = TRUE)

## End(Not run)