Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!
Get Started for Free

render_page

Render page with template

Description

Each page is composed of four templates: "head", "header", "content", and "footer". Each of these templates is rendered using the data, and then assembled into an overall page using the "layout" template.

Usage

render_page(pkg = ".", name, data, path = "", depth = NULL, quiet = FALSE)

data_template(pkg = ".", depth = 0L)

Arguments

pkg

Path to package to document.
name

Name of the template (e.g. "home", "vignette", "news")
data

Data for the template.

This is automatically supplemented with three lists:

  • site: title and path to root.

  • yaml: the template key from _pkgdown.yml.

  • package: package metadata including name andversion.

See the full contents by running data_template().
path

Location to create file; relative to destination directory. If "" (the default), prints to standard out.
depth

Depth of path relative to base directory.
quiet

If quiet, will suppress output messages
pkgdown

Make Static HTML Documentation for a Package

v1.6.1
MIT + file LICENSE
Authors
Hadley Wickham [aut, cre] (<https://orcid.org/0000-0003-4757-117X>), Jay Hesselberth [aut] (<https://orcid.org/0000-0002-6299-179X>), RStudio [cph, fnd]
Initial release

We don't support your browser anymore

Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.