build_module

Description

Compared to ?build(), this function will create only markdown pages and no other site configuration, making it easier to integrate in existing hugo sites

Usage

build_module(
  path = find_source_package_root(getwd()),
  out_dir = file.path(getwd(), "docs"),
  extra_path = getwd(),
  force = FALSE,
  skip_init = FALSE,
  skip_metadata = FALSE,
  ...
)

Arguments

• path: character(1); path to source package
• out_dir: character(1); output directory to write generated site content to
• extra_path: character(1); extra directory to scan for markdown files. The default is the current working directory. This is mostly useful for finding README.md when your package root is not equal to your project root.
• force: if TRUE, replace existing docs output
• skip_init: logical(1); do not run init
• skip_metadata: logical(1); do not generate a metadata-file. See build_metadata.