build_index_page

Description

Adds the YAML section to the reference .Rd file

Usage

build_index_page(
  path = NULL,
  title,
  menu_name = NULL,
  weight,
  out_dir,
  type = "docs",
  lines = NULL,
  fl_path_from_repo_root = NA,
  github_info = NULL
)

Arguments

• path: path to source .md file. Used for reading file contents.
• title: title of the content .md file
• menu_name: title to appear in the navigation bar on the right top, default = NULL
• weight: page weight to define order of sites
• out_dir: docs output directory
• lines: specify markdown lines directly, rather than via filepath
• fl_path_from_repo_root: relative path from repository root to source .md file to use in repository links or NA
• github_info: github source metadata