pkgdown is designed to make it quick and easy to build a website for
your package. You can see pkgdown in action at
http://pkgdown.r-lib.org: this is the output of pkgdown applied to the
latest version of pkgdown. Learn more in
# Install release version from CRAN install.packages("pkgdown") # Install development version from GitHub devtools::install_github("r-lib/pkgdown")
Run pkgdown from the package directory each time you release your package:
This will generate a
docs/ directory. The home page will be generated
from your package’s
README.md, and a function reference will be
generated from the documentation in the
man/ directory. If you are
using GitHub, the easiest way to make this your package website is to
check into git, then go settings for your repo and make sure that the
GitHub pages source is set to “master branch /docs folder”.
The package also includes an RStudio add-in which you can bind to a
keyboard shortcut. I recommend
Cmd + Shift + W: it uses Cmd + Shift,
like all other package development worksheets, it replaces a rarely used
command (close all tabs), and the W is mnemonic for website.
To customise your site, create
_pkgdown.yml and modify it as described
in the documentation. Alternatively, you can also use
pkgdown/_pkgdown.yml if you need other files to customise your site.
In the wild
As at last count, pkgdown is used by over 1600 packages.
Here are a few examples created by people contributors to pkgdown:
Comparing the output with the source is a great way to learn new pkgdown techniques (particularly because ironically, the pkgdown documentation isn’t very good yet)
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.