quarto (version 1.0)

quarto_serve: Quarto Development Server

Description

Run a local web server for a Quarto project.

Usage

quarto_serve(
  dir = NULL,
  render = "none",
  port = "auto",
  host = "127.0.0.1",
  browse = TRUE,
  watch = TRUE,
  navigate = TRUE
)
quarto_serve_stop()

Arguments

dir

The project directory to serve (defaults to current working directory)

render

By default, the most recent execution results of computational documents are used to render the site (this is to optimize start up time). If you want to perform a full render prior to serving pass "all" or a vector of specific formats to render. Pass "default" to render the default format for the site.

port

Port to listen on (defaults to 4848)

host

Hostname to bind to (defaults to 127.0.0.1)

browse

Open a browser to preview the content. Defaults to using the RStudio Viewer when running within RStudio.Pass a function (e.g. utils::browseURL to override this behavior).

watch

Watch for changes and automatically reload browser.

navigate

Automatically navivate the preview browser to the most recently rendered document.

Examples

# NOT RUN {
# Run a local server for the project in the current directory
quarto_serve()

# Run server for project in "myproj" directory and preview in external
# browser (rather than RStudio Viewer)
quarto_serve("myproj", open = utils::browseURL)

# Stop any running quarto server
quarto_serve_stop()
# }
# NOT RUN {
# }