build_site

< Back to Reference | View source

build_site()

Build Package Documentation Site

Usage

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

Arguments

Argument	Description
pkg	Path to the package root directory
examples	Whether to run code examples (default TRUE)
lazy	Only rebuild files that have changed (default FALSE)
preview	Open the site in a browser after building (default FALSE)
quiet	Suppress progress messages (default FALSE)

Value

Invisibly returns the path to the built site

Description

Main functions for building a complete documentation website using Quarto. Build the complete documentation site

Orchestrates building all components of the documentation site: index page, function reference, articles from vignettes, news, and citation.

Examples

## Not run: 
# Build site for current package
build_site()

# Build with preview
build_site(preview = TRUE)

# Build lazily (only changed files)
build_site(lazy = TRUE)

## End(Not run)