build_home

Build Package Documentation Homepage

Description

Builds the homepage from README.md or index.md

Usage

build_home(
  path,
  out_dir = file.path(getwd(), "docs/content"),
  pkg_name,
  repo_root_path = find_repo_root(getwd()),
  github_info = NULL
)

Arguments

  • path: directories to scan
  • out_dir: docs output directory
  • pkg_name: package name
  • github_info: github source metadata