use_pkgdown

0th

Percentile

Use pkgdown

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.

Usage
use_pkgdown(config_file = "_pkgdown.yml", destdir = "docs")

use_pkgdown_travis()

Arguments
config_file

Path to the pkgdown yaml config file

destdir

Target directory for pkgdown docs

See Also

https://pkgdown.r-lib.org/articles/pkgdown.html#configuration

Aliases
  • use_pkgdown
  • use_pkgdown_travis
Documentation reproduced from package usethis, version 1.5.0, License: GPL-3

Community examples

Looks like there are no examples yet.