make_gh_website: Make a github pages website

Description Usage Arguments

View source: R/make_gh_website.R

Description

WARNING: If you already have a website on a gh-pages branch then this function can delete it when clean = TRUE (the defualt), so use with care. Works like quilt, except it places the output in a gh-pages branch of the current git repository so that it is available online at http://user_name.github.io/repository_name/.

Usage

1
2
make_gh_website(reset_branch = TRUE, commit = TRUE, clear = TRUE,
  push = FALSE, branch = "master", remote = "origin", ...)

Arguments

reset_branch

(logical of length 1) If TRUE, change back to the current git branch after making the webpage.

commit

(logical of length 1) If TRUE, commit all changes made to the website on the gh-pages branch.

clear

(logical of length 1) If TRUE, the contents of the gh-pages branch is deleted before the new website is copied.

push

(logical of length 1) If TRUE, push the modifications made to the gh-pages branch to the remote specified by remote. This makes the changes appear online.

branch

(character of length 1) The name of the branch in the repository that the website source exists. This is typically 'master'.

remote

(character of length 1) The name of the remote to push any changes to. Also affects the inferred location of the website online.

...

all other options are passed to quilt.


grunwaldlab/quiltr documentation built on May 17, 2019, 8:40 a.m.