use_pkgdown {usethis} | R Documentation |
pkgdown makes it easy to turn your package into a beautiful website. There are two helper functions:
use_pkgdown()
: creates a pkgdown config file and adds the file and
destination directory to .Rbuildignore
.
use_pkgdown_travis()
: helps you set up pkgdown for automatic deployment
on Travis-CI.
use_pkgdown(config_file = "_pkgdown.yml", destdir = "docs") use_pkgdown_travis()
config_file |
Path to the pkgdown yaml config file |
destdir |
Target directory for pkgdown docs |
https://pkgdown.r-lib.org/articles/pkgdown.html#configuration