pkgdown is designed to make it quick and easy to build a website for your package. You can see pkgdown in action athttps://pkgdown.r-lib.org: this is the output of pkgdown applied to the latest version of pkgdown. Learn more invignette("pkgdown") or?build_site.
Installation
# Install released version from CRANinstall.packages("pkgdown")Usage
Get started withusethis:
# Run once to configure your package to use and deploy pkgdownusethis::use_pkgdown_github_pages()# Preview your site locally before publishingpkgdown::build_site()This adds the necessary components and sets up GitHub Actions1 for automatic site building when deploying. YourREADME.md becomes the homepage, documentation inman/ generates a function reference, and vignettes will be rendered intoarticles/.
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:
Then learn about the many new ways to customise your site invignette("customise").
In the wild
At last count, pkgdown is usedby over 12,000 packages. Here are a few examples:
bayesplot (source): plotting functions for posterior analysis, model checking, and MCMC diagnostics.
valr (source): read and manipulate genome intervals and signals.
mkin (source): calculation routines based on the FOCUS Kinetics Report
NMF (source): a framework to perform non-negative matrix factorization (NMF).
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 aContributor Code of Conduct. By participating in this project you agree to abide by its terms.