Skip to content
/ pkgdown Public

Generate static html documentation for an R package

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
LICENSE.md
Notifications You must be signed in to change notification settings

r-lib/pkgdown

Folders and files

NameName
Last commit message
Last commit date
Jan 3, 2025
Jan 27, 2025
Jan 29, 2025
Jan 27, 2025
Dec 10, 2024
Jul 4, 2024
Sep 17, 2024
Jan 27, 2025
May 31, 2024
Jan 29, 2025
Dec 10, 2024
Oct 17, 2018
Dec 10, 2024
May 16, 2024
Sep 24, 2024
Nov 1, 2023
Nov 1, 2023
Jul 14, 2024
Jan 29, 2025
Jun 12, 2024
Jun 12, 2024
Jul 18, 2020
Jul 5, 2024
Jun 7, 2024

Repository files navigation

pkgdown

CRAN Status R-CMD-check Codecov test coverage

pkgdown is designed to make it quick and easy to build a website for your package. You can see pkgdown in action at https://pkgdown.r-lib.org: this is the output of pkgdown applied to the latest version of pkgdown. Learn more in vignette("pkgdown") or ?build_site.

Installation

# Install released version from CRAN
install.packages("pkgdown")
# Install development version from GitHub
# install.packages("pak")
pak::pak("r-lib/pkgdown")

Usage

Get started with usethis:

# Run once to configure your package to use and deploy pkgdown
usethis::use_pkgdown_github_pages()
# Preview your site locally before publishing
pkgdown::build_site()

This adds the necessary components and sets up GitHub Actions1 for automatic site building when deploying. Your README.md becomes the homepage, documentation in man/ generates a function reference, and vignettes will be rendered into articles/.

pkgdown 2.0.0 and Bootstrap 5

pkgdown 2.0.0 includes an upgrade from Bootstrap 3 to Bootstrap 5, which is accompanied by a whole bunch of minor UI improvements. If you’ve heavily customised your site, there’s a small chance that this will break your site, so everyone needs to explicitly opt-in to the upgrade by adding the following to _pkgdown.yml:

template:
  bootstrap: 5

Then learn about the many new ways to customise your site in vignette("customise").

In the wild

At last count, pkgdown is used by over 12,000 packages. Here are a few examples:

Comparing the source and output of these sites is a great way to learn new pkgdown techniques.

Code of conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Footnotes

  1. If you don’t use GitHub, you can use usethis::use_pkgdown() + pkgdown::build_site() to create a website.