| Title: | Build 'pkgdown' Websites Offline |
| Version: | 0.1.1 |
| Description: | 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) <doi:10.32614/CRAN.package.pkgdown>. |
| License: | MIT + file LICENSE |
| URL: | https://nanx.me/pkgdown.offline/, https://github.com/nanxstats/pkgdown.offline |
| BugReports: | https://github.com/nanxstats/pkgdown.offline/issues |
| Encoding: | UTF-8 |
| Imports: | pkgdown |
| Suggests: | knitr, rmarkdown, testthat (≥ 3.0.0) |
| VignetteBuilder: | knitr |
| Config/testthat/edition: | 3 |
| RoxygenNote: | 7.3.2 |
| NeedsCompilation: | no |
| Packaged: | 2025-05-25 21:56:35 UTC; nanx |
| Author: | Nan Xiao  [aut,
cre, cph],
John Blischak
[aut],
Algolia, Inc. and other contributors [ctb, cph] (autocomplete.js
library),
Aidan Feldman [ctb, cph] (bootstrap-toc library),
Zeno Rocha [ctb, cph] (clipboard.js library),
Nick Williams [ctb, cph] (headroom.js library),
Julian Kühnel [ctb, cph] (mark.js library),
Kiro Risk [ctb, cph] (Fuse.js library),
Khan Academy and other contributors [ctb, cph] (KaTeX library),
The MathJax Consortium [ctb, cph] (MathJax library) |
| Maintainer: | Nan Xiao <me@nanx.me> |
| Repository: | CRAN |
| Date/Publication: | 2025-05-25 22:10:02 UTC |
pkgdown.offline: Build 'pkgdown' Websites Offline
Description
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) doi:10.32614/CRAN.package.pkgdown.
Author(s)
Maintainer: Nan Xiao me@nanx.me (ORCID) [copyright holder]
Authors:
John Blischak (ORCID)
Other contributors:
Algolia, Inc. and other contributors (autocomplete.js library) [contributor, copyright holder]
Aidan Feldman (bootstrap-toc library) [contributor, copyright holder]
Zeno Rocha (clipboard.js library) [contributor, copyright holder]
Nick Williams (headroom.js library) [contributor, copyright holder]
Julian Kühnel (mark.js library) [contributor, copyright holder]
Kiro Risk (Fuse.js library) [contributor, copyright holder]
Khan Academy and other contributors (KaTeX library) [contributor, copyright holder]
The MathJax Consortium (MathJax library) [contributor, copyright holder]
See Also
Useful links:
Report bugs at https://github.com/nanxstats/pkgdown.offline/issues
Build a complete pkgdown website offline
Description
Builds a pkgdown website without requiring internet connection by using cached dependencies. Detects the installed pkgdown version and applies the appropriate offline build strategy.
Usage
build_site(...)
Arguments
... |
Arguments passed to |
Value
Invisible NULL, called for side effect of building the website.
Examples
## Not run:
pkgdown.offline::build_site(override = list(destination = tempdir()))
## End(Not run)
Clear pkgdown cache if any
Description
Removes all files from the pkgdown cache directory if it exists. This is useful when troubleshooting or when you want to force a fresh caching of pkgdown external dependencies.
Usage
clear_cache()
Value
Invisible NULL, called for side effect of clearing the cache.
Examples
## Not run:
pkgdown.offline::clear_cache()
## End(Not run)
Initialize site infrastructure offline
Description
Sets up the necessary infrastructure for building a pkgdown site offline by copying locally cached dependencies to the pkgdown cache directory.
Usage
init_site(...)
Arguments
... |
Arguments passed to |
Value
Invisible NULL, called for side effect of initializing site resources.
Examples
## Not run:
pkgdown.offline::init_site(override = list(destination = tempdir()))
## End(Not run)