preview_docs {altdoc}

Preview the documentation in a webpage or in viewer

Description

Preview the documentation in a webpage or in viewer

Usage

preview_docs(path = ".")

Arguments

path

Path to the package root directory.

Value

No value returned. If RStudio is used, it shows a site preview in Viewer. To preview the site in a browser or in another text editor (ex: VS Code), see the vignette on the altdoc website.

Examples

if (interactive()) {

  preview_docs()

}

# This is an example to illustrate that code-generated images are properly
# displayed. See the `altdoc` website for a rendered version.
with(mtcars, plot(mpg, wt))