Writes the index of the reference pages into a Quarto file

write_reference_index

Description

Writes the index of the reference pages into a Quarto file

Usage

write_reference_index(
  project = ".",
  pkg = NULL,
  folder = "reference",
  index_file = "index.qmd",
  index_template = NULL
)

Arguments

Arguments	Description
project	The path to the root folder of the project.
pkg	The path inside the project folder. Use only if the R package itself is in a sub-folder within the project.
folder	The target folder to save the new Quarto files to
index_file	The name assigned to the resulting index Quarto file
index_template	The path to a Quarto file that can be used as the template for the index Quarto file

Value

A Quarto file that links to the individual Quarto documentation files

See Also

Other Quarto file creation: write_reference(), write_reference_pages()