pkgdown Documentation

You can install the released version of pkgdown from CRAN or the development version from GitHub.

Install from CRAN

Use the standard install.packages() command.

Install development version from GitHub

It is recommended to use pak to install the development version.

If you do not use GitHub, you can use usethis::use_pkgdown() followed by pkgdown::build_site() to create a website locally.

# Install released version from CRAN
install.packages("pkgdown")

# Install development version from GitHub
pak::pak("r-lib/pkgdown")

Before publishing your site, you can build and preview it locally using pkgdown::build_site().

# Preview your site locally before publishing
pkgdown::build_site()

To set up your package for automatic site building and deployment via GitHub Actions, use the usethis package. This process:

• Configures your package to use and deploy pkgdown.
• Sets up GitHub Actions for automatic site building.
• Converts your README.md into the homepage.
• Generates a function reference from documentation in man/.
• Renders vignettes into articles/.

If you are not using GitHub, use usethis::use_pkgdown() instead.

# Run once to configure your package to use and deploy pkgdown
usethis::use_pkgdown_github_pages()

Starting with version 2.0.0, pkgdown upgraded from Bootstrap 3 to Bootstrap 5. To prevent breaking existing highly customized sites, this upgrade requires an explicit opt-in. Add the following configuration to your _pkgdown.yml file to use Bootstrap 5.

template:
  bootstrap: 5