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. There are two helper functions:<ul>
<li><code>use_pkgdown()</code>: creates a pkgdown config file and adds the file and
destination directory to <code>.Rbuildignore</code>.</li>
<li><code>use_pkgdown_travis()</code>: helps you set up pkgdown for automatic deployment
on Travis-CI. Specifically, it:<ul>
<li>Adds the <code>docs/</code> folder to <code>.gitignore</code> and <code>.Rbuildignore</code>.</li>
<li>Builds favicons if your package contains a package logo,
and adds the resulting <code>pkgdown/</code> folder to <code>.Rbuildignore</code>.</li>
<li>Creates an empty <code>gh-pages</code> branch for the pkgdown site to be
deployed to.</li>
<li>Prompts you about what to do next regarding Travis-CI deployment
keys and updating your <code>.travis.yml</code>.</li>
</ul></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. There are two helper functions:<ul>
<li><code>use_pkgdown()</code>: creates a pkgdown config file and adds the file and
destination directory to <code>.Rbuildignore</code>.</li>
<li><code>use_pkgdown_travis()</code>: helps you set up pkgdown for automatic deployment
on Travis-CI. Specifically, it:<ul>
<li>Adds the <code>docs/</code> folder to <code>.gitignore</code> and <code>.Rbuildignore</code>.</li>
<li>Builds favicons if your package contains a package logo,
and adds the resulting <code>pkgdown/</code> folder to <code>.Rbuildignore</code>.</li>
<li>Creates an empty <code>gh-pages</code> branch for the pkgdown site to be
deployed to.</li>
<li>Prompts you about what to do next regarding Travis-CI deployment
keys and updating your <code>.travis.yml</code>.</li>
</ul></li>
</ul>

use_pkgdown: Use pkgdown

Description

Usage

Arguments

See Also