index.html: Generate an 'index.html' File

Description Usage Arguments Value

View source: R/indexHTML.R

Description

Generate an index.html File

Usage

1
2
3
4
5
6
index.html(
  files,
  sourceDir = NULL,
  destDir = dirname(files[[1L]]$path),
  metadata
)

Arguments

files

a list of (path, desc) tuples with file paths and corresponding descriptions

sourceDir

the source directory: used to resolve the include

destDir

the destination directory

metadata

the meta data

Value

the canonical path to the index.html file


thomasWeise/bookbuildeR documentation built on Sept. 5, 2021, 6:31 p.m.