Build 'pkgdown' Websites Offline

Provides support for building 'pkgdown' websites without an internet connection. Works by bundling cached dependencies and implementing drop-in replacements for key 'pkgdown' functions. Enables package documentation websites to be built in environments where internet access is unavailable or restricted. For more details on generating 'pkgdown' websites, see Wickham et al. (2025) .

pkgdown.offline

pkgdown.offline provides support for offline builds of pkgdown websites, especially for pkgdown versions >= 2.1.0.

It works by bundling cached frontend dependencies from different pkgdown versions and implementing drop-in replacements for key functions. This allows you to build documentation websites in development workflows or CI/CD pipelines without internet access.

Installation

You can install pkgdown.offline from CRAN:

install.packages("pkgdown.offline")

Or try the development version from GitHub:

# install.packages("remotes")
remotes::install_github("nanxstats/pkgdown.offline")

Usage

Use pkgdown.offline::build_site() and pkgdown.offline::init_site() to replace the original pkgdown::build_site() or pkgdown::init_site() calls in your original development or CI/CD workflow.

Disclaimer

pkgdown.offline is an independent third-party solution not endorsed by, affiliated with, or supported by the authors of pkgdown. It is developed solely as a community contribution to address a specific use case and is not an official extension of the pkgdown project.

Contributing

We welcome contributions to pkgdown.offline. Please read the Contributing Guidelines first.

All interactions within pkgdown.offline repositories and issue trackers should adhere to the Contributor Code of Conduct.