build_vignettes

Build the articles section from vignettes

Description

build_vignettes() renders each R Markdown file within vignettes/ and saves it to articles/.

Usage

build_vignettes(
  path,
  out_dir = file.path(getwd(), "docs/content/articles"),
  force = FALSE,
  clean = TRUE,
  base_url = "localhost:1313",
  repo_root_path = find_repo_root(getwd()),
  github_info = NULL,
  static_dir = file.path(getwd(), "docs/static/articles")
)

Arguments

path: character(1); full path to source package including name
out_dir: character(1); output directory to write rendered vignettes to
force: logical(1); if TRUE, overwrite rendered vignettes if they exist
clean: logical(1); remove temporary files
repo_root_path: character(1); repository root path or NA