preview_site: Open site in browser
In pkgdown: Make Static HTML Documentation for a Package
preview_site R Documentation
Open site in browser
Description
preview_site() opens your pkgdown site in your browser, served via a
local HTTP server. This enables dynamic features such as search to work
correctly in preview.
Usage
preview_site(pkg = ".", path = ".", preview = TRUE)
Arguments
pkg
Path to package.
path
Path relative to destination
preview
If TRUE, or is.na(preview) && interactive(), will preview
freshly generated section in browser.
See Also
stop_preview() to stop the server.
pkgdown documentation built on July 8, 2026, 1:07 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| preview_site | R Documentation |
Open site in browser
Description
preview_site() opens your pkgdown site in your browser, served via a
local HTTP server. This enables dynamic features such as search to work
correctly in preview.
Usage
preview_site(pkg = ".", path = ".", preview = TRUE)
Arguments
pkg |
Path to package. |
path |
Path relative to destination |
preview |
If |
See Also
stop_preview() to stop the server.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.