pkgdown: deploy_to_branch – R documentation

Pricing

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Get Started for Free

Documentation

pkgdown

deploy_to_branch

Build and deploy a site locally

Description

Assumes that you're in a git clone of the project, and the package is already installed.

Usage

deploy_to_branch(
  pkg = ".",
  commit_message = construct_commit_message(pkg),
  clean = FALSE,
  branch = "gh-pages",
  remote = "origin",
  github_pages = (branch == "gh-pages"),
  ...
)

Arguments

`pkg`	Path to package.
`commit_message`	The commit message to be used for the commit.
`clean`	Clean all files from old site.
`branch`	The git branch to deploy to
`remote`	The git remote to deploy to
`github_pages`	Is this a GitHub pages deploy. If `TRUE`, adds a `CNAME` file for custom domain name support, and a `.nojekyll` file to suppress jekyll rendering.
`...`	Additional arguments passed to `build_site()`.

pkgdown

Make Static HTML Documentation for a Package

v1.6.1

MIT + file LICENSE

Authors

Hadley Wickham [aut, cre] (<https://orcid.org/0000-0003-4757-117X>), Jay Hesselberth [aut] (<https://orcid.org/0000-0002-6299-179X>), RStudio [cph, fnd]

Initial release

deploy_to_branch

Description

Usage

Arguments

pkgdown

We don't support your browser anymore