pkgdown

2.2.1

Make Static HTML Documentation for a Package

266packages depend

2.6Mdownloads / year

87.5%test coverage

13/13checks pass

Overview

About

Maintained by Hadley WickhamFirst published 2018-05-0326 releasesCRAN page ↗GitHub ↗

Generate an attractive and useful website from a source package. 'pkgdown' converts your documentation, vignettes, 'README', and more to 'HTML' making it easy to share information about your package online.

Install

R (CRAN)pak (dev)Ubuntu (r2u)Fedora (COPR)openSUSE (OBS)

install.packages("pkgdown", repos = "https://cloud.r-project.org/")

Installs the current CRAN release. Prebuilt binaries on Windows and macOS.

if (!requireNamespace("pak", quietly = TRUE))
  install.packages("pak", repos = "https://cloud.r-project.org/")
pak::pak("r-lib/pkgdown")

Development version from r-lib/pkgdown. Installs pak first if it is not already available.

Release

# enable cranapt (r2u) if it is not already set up, then install
grep -rqs r2u.stat.illinois.edu /etc/apt/sources.list /etc/apt/sources.list.d/ \
  || curl -fsSL https://raw.githubusercontent.com/eddelbuettel/r2u/master/inst/scripts/add_cranapt_noble.sh | sudo bash
sudo apt install -y r-cran-pkgdown

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled.

bspm (used by r2u) also needs make: sudo apt install make

# enable the iucar/cran COPR if it is not already present, then install
ls /etc/yum.repos.d/*iucar*cran*.repo >/dev/null 2>&1 \
  || sudo dnf copr enable -y iucar/cran
sudo dnf install -y R-CRAN-pkgdown

RPMs from the iucar/cran COPR, rebuilt from CRAN.

For install.packages() integration in R, also: sudo dnf install R-CoprManager

# add the autoCRAN OBS repo (Tumbleweed) if it is missing, then install
zypper -q lr | grep -qi autoCRAN \
  || sudo zypper addrepo https://download.opensuse.org/repositories/devel:/languages:/R:/autoCRAN/openSUSE_Tumbleweed/devel:languages:R:autoCRAN.repo
sudo zypper install -y R-pkgdown

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed).

Health

CRAN checks

13OK

Slowest check: 9.1 min · r-devel-linux-x86_64-fedora-clang

Code health

Yes

Tests · ratio 0.74

87.5%

Coverage · measured lines

100%

Documentation · exports

Dependencies · direct

Check history

OK2026-07-11
13 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
ERROR2026-04-27
11 OK · 0 NOTE · 0 WARNING · 1 ERROR · 0 FAILURE
OK2026-03-10
14 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE

Documentation

READMEYes · 341 wordsVignettesYes · dynamicpkgdown siteNoNEWSYes · 100% structuredCode of conductNoContributing guideNo

Examples that run: 91%
Documented parameters: 100%
Return-value docs: 8%
References docs: 0%

Downloads

2.6M

CRAN downloads in the past year

Rank #227 · ~7.1K/day · ~216.1K/mo

Releases R versions

Daily download trend is not available in this view yet.

233K30 days

682.8K90 days

2.6M1 year

Compare downloads with other packages →

Also on95.3K r2u49 autocran222.2K conda_forge23 c2d4u

Repository

GitHub ↗ r-lib/pkgdown

771Stars

351Forks

72Open issues

26Open PRs

27Releases

2,574Commits

155Contributors

rpackagedocumentation-tool

2,574 commits · Last activity 2026-07-13

Issues over time

2026-07-09 · 712026-07-17 · 72

Repository practices

Upstream repositoryBeta

11 development-tooling and community-health practices detected across 7 families in the upstream repository

Checks run against github.com/r-lib/pkgdown on 2026-07-19.

Continuous integration (1)

GitHub Actions

CRAN release process (2)

cran-comments.mdrevdep/

Docs source (1)

README.Rmd

Lint, format, editor (3)

AirVS CodeRStudio project

Show all practices

Coverage (1)

Codecov

Governance and community (1)

CODEOWNERS

Git structural (2)

.gitattributesblame-ignore revs

How this is detected·Detection ruleset v1 (2026-07-18)

Dependencies

Declared dependencies

37 external dependencies (excludes base and recommended)

Depends (1)

R >= 4.1

Imports (20)

bslib callr cli desc (>= 1.4.0)downlit fontawesome fs httr2 jsonlite lifecycle openssl purrr ragg rlang rmarkdown tibble whisker withr xml2 yaml

LinkingTo (0)

none

Suggests (19)

covr diffviewer evaluate gert gt htmltools htmlwidgets knitr magickmethodsnanonext (>= 1.8.0)pkgload quarto rsconnect rstudioapi rticles sass testthattools

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

266direct

79indirect

and 218 more packages.

Code & Tests

Code Composition

R 19,163 (66%)Other 2,950 (10%)Rd 2,584 (9%)Markdown 2,108 (7%)Vignettes 1,867 (6%)HTML 408 (1%)YAML 28 (0%)

Code characteristics

Object systems

S3108

Cyclomatic complexity: 2.0 median / 23 max
Test cases: 456 / 0.74 per code line
System requirements: 1 external

Test coverage

Line coverage

88%

Expression

88.5%

Tests / Examples

87.5% / – ex

Functions

582 34 exported

Complexity

2.3 avg / 23 max

Call network

582 nodes / 1060 edges

Call graph

Open call graph →

Loading call graph…

Lowest coverage

582 functions

Function	Cyclo	Coverage
build_site_github_pages exp	2	0%
clean_cache exp	3	0%
deploy_site_github exp	5	0%
deploy_to_branch exp	5	0%
in_pkgdown exp	1	0%
template_articles exp	1	0%

People & History

People (6)

Maintainer (1)

Hadley Wickham

Author, Maintainer

Authors (5)

Hadley Wickham

Author, Maintainer

Salim Brüggemann

Author · added in 2.1.0

Jay Hesselberth

Author

Olivier Roy

Author · added in 2.1.0

Maëlle Salmon

Author · added in 2.0.0

Posit Software, PBC

Funders (1)

Posit Software, PBC

Listed in earlier versions (1)

RStudio

no longer listed · 1.0.0 to 2.0.7

Package Timeline

26 releases. Pick two to compare their code metrics. R releases are shown for context.

2.2.1Latest
2026-07-08 · current release · diff ↗
R
R 4.6.0 released · 2026-04-24
2.2.0
2025-11-06 · diff ↗
2.1.3
2025-05-25 · diff ↗
2.1.2
2025-04-28 · diff ↗
R
R 4.5.0 released · 2025-04-11
2.1.1
2024-09-18 · diff ↗
2.1.0
2024-07-07 · diff ↗
R
R 4.4.0 released · 2024-04-24
2.0.9
2024-04-18 · diff ↗
2.0.8
2024-04-10 · diff ↗
R
R 4.3.0 released · 2023-04-21
2.0.7
2022-12-14 · diff ↗
2.0.6
2022-07-16 · diff ↗
2.0.5
2022-06-23 · diff ↗
2.0.4
2022-06-10 · diff ↗

Show 19 earlier events

2.0.3
2022-04-24 · diff ↗
R
R 4.2.0 released · 2022-04-22
2.0.2
2022-01-13 · diff ↗
2.0.1
2021-12-03 · diff ↗
2.0.0
2021-11-30 · diff ↗
R
R 4.1.0 released · 2021-05-18
1.6.1
2020-09-12 · diff ↗
1.6.0
2020-09-07 · diff ↗
R
R 4.0.0 released · 2020-04-24
1.5.1
2020-04-09 · diff ↗
1.5.0
2020-03-25 · diff ↗
1.4.1
2019-09-15 · diff ↗
1.4.0
2019-09-03 · diff ↗
R
R 3.6.0 released · 2019-04-26
1.3.0
2018-12-07 · diff ↗
1.2.0
2018-11-20 · diff ↗
1.1.0
2018-06-03 · diff ↗
1.0.0
2018-05-03
R
R 3.5.0 released · 2018-04-23

Package metadata

First published: 2018-05-03
Total releases: 26 / 8 yrs
License: MIT + file LICENSE OSI
Minimum R: ≥ 4.1
Download size: 1.2 MB
Installed size: not tracked yet
With dependencies: not tracked yet

Report a problem with this page →