Generate Examples menu in pkgdown — add_pkgdown

Scans for HTML files in a directory (default is pkgdown/assets/examples) and updates a standard _pkgdown.yml with a new sub-menu listing the html files.

Usage

add_pkgdown_examples(
  examples_dir = "pkgdown/assets/examples",
  pkgdown_yml = "_pkgdown.yml",
  rmd_dir = "inst/examples"
)

Arguments

examples_dir: Character. Path to directory containing example HTML files. Default is "pkgdown/assets/examples".
pkgdown_yml: Character. Path to _pkgdown.yml file to update with menu. Default is "_pkgdown.yml".
rmd_dir: Character. Path to directory containing example .Rmd files used to derive titles and order. Default is "inst/examples".

Value

NULL invisibly.