build_site

R Documentation

Build the pkgdown documentation site

Description

Builds the repository documentation website using the checked-in '_pkgdown.yml' configuration and writes the rendered output to the configured destination directory.

Usage

build_site(
  root = ".",
  install = TRUE,
  live_examples = FALSE,
  preview = FALSE,
  strict_link_audit = FALSE,
  verbose = interactive()
)

Arguments

root	Repository root directory.
install	Logical scalar. If 'TRUE', installs the package into a temporary library before building the site.
live_examples	Logical scalar. If 'TRUE', exports standalone 'shinylive' examples from 'vignettes/shinylive-examples/' into the built site.
preview	Logical scalar. If 'TRUE', asks 'pkgdown' to preview the site after the build completes.
strict_link_audit	Logical scalar. If 'TRUE', fail when 'lychee' is missing or reports broken website links after the site build.
verbose	Logical scalar. If 'TRUE', emits tool-level progress output.

Details

CLI entry point: './tools/build_site.R –help'

When generated tool docs are present under 'tools/man/', this tool also copies them into the built site under 'tool-docs/'. When app sources are present under 'vignettes/shinylive-examples/', this tool can also publish matching standalone live-example targets under 'live-examples/' when 'live_examples = TRUE'. It also audits the built local site links with 'lychee'.

If 'lychee' is not on 'PATH', set 'SHINY_WEBAWESOME_LYCHEE=/path/to/lychee'.

Value

A list describing the site build, including the normalized root directory, the configured destination directory, and whether installation and preview were enabled.

Examples

## Not run: 
build_site()
build_site(install = FALSE)

## End(Not run)