# pkgdown 
[](https://app.codecov.io/gh/r-lib/pkgdown?branch=main)
pkgdown is designed to make it quick and easy to build a website for
your package. You can see pkgdown in action at
: this is the output of pkgdown applied to
the latest version of pkgdown. Learn more in `vignette("pkgdown")` or
`?build_site`.
## Installation
``` r
# Install released version from CRAN
install.packages("pkgdown")
```
``` r
# Install development version from GitHub
devtools::install_github("r-lib/pkgdown")
```
## Usage
Get started with [usethis](https://usethis.r-lib.org/):
``` r
# Run once to configure your package to use pkgdown
usethis::use_pkgdown()
```
Then use pkgdown to build your website:
``` r
pkgdown::build_site()
```
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 `articles/`.
Read `vignette("pkgdown")` for more details, and to learn how to deploy
your site to GitHub pages.
### 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.yaml`:
``` yaml
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 6,000
packages](https://github.com/search?q=filename%3Apkgdown.yml+path%3A%2F&type=Code).
Here are a few examples created by contributors to pkgdown:
- [bayesplot](http://mc-stan.org/bayesplot/index.html)
([source](https://github.com/stan-dev/bayesplot/tree/gh-pages)):
plotting functions for posterior analysis, model checking, and MCMC
diagnostics.
- [valr](https://rnabioco.github.io/valr/)
([source](https://github.com/rnabioco/valr)): read and manipulate
genome intervals and signals.
- [mkin](https://pkgdown.jrwb.de/mkin/)
([source](https://github.com/jranke/mkin)): calculation routines
based on the FOCUS Kinetics Report
- [NMF](http://renozao.github.io/NMF/master/index.html)
([source](https://github.com/renozao/NMF)): 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 a [Contributor Code of
Conduct](https://pkgdown.r-lib.org/CODE_OF_CONDUCT.html). By
participating in this project you agree to abide by its terms.