pkgdown is an R package that generates static HTML documentation websites for R packages.
It takes the material already present in a package, including README files, function documentation, vignettes, articles, and metadata, and turns it into a browsable website that can be published online and updated as the package evolves.
This is free and open source software.
Key Features
- Builds static HTML websites for R packages from existing package source files.
- Converts README content, manual pages, and vignettes into structured web pages.
- Provides a local preview workflow before publishing documentation online.
- Supports GitHub Pages deployment and GitHub Actions based site building.
- Offers customisable templates, Bootstrap 5 styling, articles, reference indexes, and package metadata pages.
Website: github.com/r-lib/pkgdown
Support:
Developer: Hadley Wickham, Jay Hesselberth, Maëlle Salmon, Olivier Roy, Salim Brüggemann, and Posit Software, PBC
License: MIT License
pkgdown is written in R. Learn R with our recommended free books and free tutorials.
Related Software
| R Static Site Generators | |
|---|---|
| Bookdown | R package to facilitate writing books |
| rmarkdown | Create dynamic analysis documents combining code, rendered output, and prose |
| Blogdown | Powerful and customizable website output format for R Markdown |
Read our verdict in the software roundup.
 Explore our comprehensive directory of recommended free and open source software. Our carefully curated collection spans every major software category.This directory is part of our ongoing series of informative articles for Linux enthusiasts. It features hundreds of detailed reviews, along with open source alternatives to proprietary solutions from major corporations such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk. You’ll also find interesting projects to try, hardware coverage, free programming books and tutorials, and much more. Discovered a useful open source Linux program that we haven’t covered yet? Let us know by completing this form. |