deploy_to_branch: Build and deploy a site locally

Description Usage Arguments

View source: R/deploy-site.R

Description

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

Usage

1
2
3
4
5
6
7
8
9
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().


Paradigm4/pkgdown documentation built on June 3, 2020, 12:30 a.m.