Skip to content

Publish a book to the web

Source: R/publish.R
publish_book.Rd

Publish a book to the web. Note that you should be sure to render all versions of the book before publishing, unless you have specified render = TRUE.

Usage

publish_book(
  name = NULL,
  account = NULL,
  server = NULL,
  render = c("none", "local", "server")
)

Arguments

name

Name of the book (this will be used in the URL path of the published book). Defaults to the book_filename in _bookdown.yml if not specified.

account

Account name to publish to. Will default to any previously published to account or any single account already associated with server.

server

Server to publish to (by default beta.rstudioconnect.com but any RStudio Connect server can be published to).

render

Rendering behavior for site:

  • "none" uploads a static version of the current contents of the site directory.

  • "local" renders the site locally then uploads it.

  • "server" uploads the source of the site to render on the server.

Note that for "none" and "local" source files (e.g. .R, .Rmd and .md) will not be uploaded to the server.