Build and deploy a site locallySource:
Assumes that you're in a git clone of the project, and the package is
already installed. Use
usethis::use_pkgdown_github_pages() to automate
this process using GitHub actions.
deploy_to_branch( pkg = ".", commit_message = construct_commit_message(pkg), clean = TRUE, branch = "gh-pages", remote = "origin", github_pages = (branch == "gh-pages"), ..., subdir = NULL )
Path to package.
The commit message to be used for the commit.
Clean all files from old site.
The git branch to deploy to
The git remote to deploy to
Is this a GitHub pages deploy. If
TRUE, adds a
CNAMEfile for custom domain name support, and a
.nojekyllfile to suppress jekyll rendering.
Additional arguments passed to
The sub-directory where the site should be built on the branch. This argument can be used to support a number of site configurations. For example, you could build version-specific documentation by setting
subdir = "v1.2.3";
deploy_to_branch()will build and deploy the package documentation in the
v.1.2.3/directory of your site.