pkgdown makes it easy to turn your package into a beautiful website. usethis provides two functions to help you use pkgdown:
use_pkgdown(): creates a pkgdown config file and adds relevant files or
use_pkgdown_github_pages(): implements the GitHub setup needed to
automatically publish your pkgdown site to GitHub pages:
(first, it calls
use_github_pages() prepares to publish the pkgdown site from the
use_github_action("pkgdown") configures a
GitHub Action to automatically build the pkgdown site and deploy it via
The pkgdown site's URL is added to the pkgdown configuration file, to the URL field of DESCRIPTION, and to the GitHub repo.
Packages owned by certain GitHub organizations (tidyverse, r-lib, and tidymodels) get some special treatment, in terms of anticipating the (eventual) site URL and the use of a pkgdown template.
use_pkgdown_travis() is deprecated; we no longer recommend that you use
1 2 3 4 5
Path to the pkgdown yaml config file
Target directory for pkgdown docs
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.