use_pkgdown

use_pkgdown_travis

Path to the pkgdown yaml config file

config_file

destdir

<a href="https://pkgdown.r-lib.org">pkgdown</a> makes it easy to turn your package into
a beautiful website. A couple functions help you begin to use pkgdown:<ul>
<li><code>use_pkgdown()</code>: creates a pkgdown config file, adds relevant files or
directories to <code>.Rbuildignore</code> and <code>.gitignore</code>, and builds favicons if
your package has a logo.</li>
<li><code>use_github_action("pkgdown")</code> configures a GitHub Actions workflow to
build and deploy your pkgdown site whenever you push changes to GitHub.
Learn more about <code><a rd-options="=use_github_action" href="/link/use_github_action()?package=usethis&version=2.0.0&to=%3Duse_github_action" data-mini-rdoc="=use_github_action::use_github_action()">use_github_action()</a></code>. This approach is actively
maintained, because it is in use across many tidyverse, r-lib, and
tidymodels packages.</li>
<li><code>use_pkgdown_travis()</code> soft-deprecated helps you set up
pkgdown for automatic deployment on Travis-CI. This is soft-deprecated,
as the tidyverse team has shifted away from Travis-CI and towards GitHub
Actions. <code>use_pkgdown_travis()</code> creates an empty <code>gh-pages</code> branch for
the site and prompts about next steps regarding deployment keys and
updating your <code>.travis.yml</code>. Requires that the current user can push to
the primary repo, which must be configured as the <code>origin</code> remote.</li>
</ul>

Automate package and project setup tasks that are
otherwise performed manually. This includes setting up unit testing,
test coverage, continuous integration, Git, 'GitHub', licenses,
'Rcpp', 'RStudio' projects, and more.

Jennifer Bryan

usethis

Automate Package and Project Setup

Hadley Wickham

RStudio 

use_pkgdown function

<a href='https://pkgdown.r-lib.org'>pkgdown</a> makes it easy to turn your package into
a beautiful website. A couple functions help you begin to use pkgdown:<ul>
<li><code>use_pkgdown()</code>: creates a pkgdown config file, adds relevant files or
directories to <code>.Rbuildignore</code> and <code>.gitignore</code>, and builds favicons if
your package has a logo.</li>
<li><code>use_github_action("pkgdown")</code> configures a GitHub Actions workflow to
build and deploy your pkgdown site whenever you push changes to GitHub.
Learn more about <code><a rd-options='=use_github_action' href='use_github_action()'>use_github_action()</a></code>. This approach is actively
maintained, because it is in use across many tidyverse, r-lib, and
tidymodels packages.</li>
<li><code>use_pkgdown_travis()</code> soft-deprecated helps you set up
pkgdown for automatic deployment on Travis-CI. This is soft-deprecated,
as the tidyverse team has shifted away from Travis-CI and towards GitHub
Actions. <code>use_pkgdown_travis()</code> creates an empty <code>gh-pages</code> branch for
the site and prompts about next steps regarding deployment keys and
updating your <code>.travis.yml</code>. Requires that the current user can push to
the primary repo, which must be configured as the <code>origin</code> remote.</li>
</ul>

use_pkgdown: Use pkgdown

Description

Usage

Arguments

See Also