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 |
| Quarto | Scientific and technical publishing system |
| workflowr | Helps researchers organize analysis projects |
| pkgdown | R package that generates static HTML documentation websites |
| altdoc | Create, render, preview, and deploy documentation websites |
| sandpaper | Provides the user interface for The Carpentries Workbench |
Read our verdict in the software roundup.
 Explore our carefully curated directory of recommended free and open source software, covering every major software category.The directory forms part of our extensive collection of articles for Linux enthusiasts. It includes hundreds of detailed reviews, together with free and open source alternatives to proprietary software from companies such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk. LinuxLinks also covers interesting projects worth exploring, Linux-compatible hardware, free programming books and tutorials, and much more. Know a useful free and open source Linux application that we haven’t covered? Tell us about it using our submission form. |
Please read our Comment Policy before commenting.