Activates or reconfigures a GitHub Pages site for a project hosted on GitHub. This function anticipates two specific usage modes:
Publish from the root directory of a
gh-pages branch, which is assumed to
be only (or at least primarily) a remote branch. Typically the
branch is managed by an automatic "build and deploy" job, such as the one
Publish from the
"/docs" directory of a "regular" branch, probably the
repo's default branch. The user is assumed to have a plan for how they will
manage the content below
use_github_pages(branch = "gh-pages", path = "/", cname = NA)
Branch and path for the site source. The default of
The most common alternative is to use the repo's default branch, coupled
Note that GitHub does not support an arbitrary
Optional, custom domain name. The
Note that this can add or modify a CNAME file in your repository. If you are using Pages to host a pkgdown site, it is better to specify its URL in the pkgdown config file and let pkgdown manage CNAME.
Site metadata returned by the GitHub API, invisibly
use_github_pages() with other
functions to fully configure a pkgdown site
## Not run: use_github_pages() use_github_pages(branch = git_default_branch(), path = "/docs") ## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.