build_presentations: Each Rmarkdown Xaringan presentation in 'Presentations/' is...

In CenterForAssessment/packagePages: Customized Clone of pkgdown for Creating Static HTML Documentation for an R Package

Each Rmarkdown Xaringan presentation in Presentations/ is rendered. Rendered html and associated directories are placed within docs/presentations/

Description

In addition, a small file is created in Documents/presentations that is embeds the presentation into the website generated by packagePages()/projectPages()

Usage

build_presentations(
  output_directory = "docs/presentations",
  depth = 1L,
  encoding = "UTF-8",
  quiet = TRUE,
  input_presentations_directory = "Presentations"
)

Arguments

output_directory	Output path. Relative paths are taken relative to the pkg directory.
depth	Depth of path relative to root of documentation. Used to adjust relative links in the navbar.
encoding	The encoding of the input files.
quiet	Set to 'FALSE' to display output of knitr and pandoc. This is useful when debugging.
input_presentations_directory	Defaults to Presentations

Details

If you want articles that are not vignettes, either put them in subdirectories or list in .Rbuildignore. An articles link will be automatically added to the default navbar if the vignettes directory is present: if you do not want this, you will need to customise the navbar. See build_site details.

Build presentations

CenterForAssessment/packagePages documentation built on Oct. 15, 2024, 6:34 p.m.