File: publish_site.Rd

package info (click to toggle)
r-cran-rmarkdown 2.20%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 8,028 kB
  • sloc: javascript: 5,656; sh: 24; makefile: 17
file content (48 lines) | stat: -rw-r--r-- 1,365 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/publish_site.R
\name{publish_site}
\alias{publish_site}
\title{Publish an R Markdown Website}
\usage{
publish_site(
  site_dir = ".",
  site_name = NULL,
  method = c("rsconnect"),
  server = NULL,
  account = NULL,
  render = TRUE,
  launch_browser = interactive()
)
}
\arguments{
\item{site_dir}{Directory containing website. Defaults to current working directory.}

\item{site_name}{Name for the site (names must be unique within an account). Defaults
to the `name` provided by the site generator (or to the name of the site_dir if
there is no `name` specified).}

\item{method}{Publishing method (currently only "rsconnect" is available)}

\item{server}{Server name. Required only if you use the same account name on
multiple servers.}

\item{account}{Account to deploy application to. This parameter is only required for
the initial deployment of an application when there are multiple accounts configured
on the system.}

\item{render}{`TRUE` to render the site locally before publishing.}

\item{launch_browser}{If `TRUE`, the system's default web browser will be launched
automatically after the site is deployed. Defaults to `TRUE` in interactive sessions
only.}
}
\description{
Publish a website to RStudio Connect
}
\examples{
\dontrun{
library(rmarkdown)
publish_site()
}

}