Auto-linking

Within a package

pkgdown will automatically link to documentation and articles wherever it’s possible to do unambiguously. This includes:

Across packages

Linking to documentation in another package is straightforward. Just adapt the call in the usual way:

If pkgdown can find a pkgdown site for the remote package, it will link to it; otherwise it will link to http://rdrr.io/ for documentation, and CRAN for vignettes. In order for a pkgdown site to be findable, it needs to be listed in two places:

Now, when you build a pkgdown site for a package that links to the dplyr documentation (e.g., dplyr::mutate()), pkgdown looks first in dplyr’s DESCRIPTION to find its website, then it looks for pkgdown.yml, and uses the metadata to generate the correct links.