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
# Install released version from CRAN install.packages("pkgdown")
Get started with usethis:
# Run once to configure your package to use pkgdown usethis::use_pkgdown()
Then use pkgdown to build your website:
This generates a
docs/ directory containing a website. Your
README.md becomes the homepage, documentation in
man/ generates a function reference, and vignettes will be rendered into
vignette("pkgdown") for more details, and to learn how to deploy your site to GitHub pages.
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
Then learn about the many new ways to customise your site in
At last count, pkgdown is used by over 6,000 packages. Here are a few examples created by contributors to pkgdown:
Comparing the source and output of these sites is a great way to learn new pkgdown techniques.
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.