preview_site: Open site in browser

View source: R/preview.R

preview_siteR Documentation

Open site in browser

Description

preview_site() opens your pkgdown site in your browser. pkgdown has been carefully designed to work even when served from the file system like this; the only part that doesn't work is search. You can use servr::httw("docs/") to create a server to make search work locally.

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.


pkgdown documentation built on Sept. 18, 2024, 1:06 a.m.