Static Site Generator

pkgsite – create Quarto documentation for R packages

pkgsite is a package for generating Quarto documentation websites for R packages. It converts compiled Rd help files into individual Quarto Markdown documents and creates a reference index containing the package’s exported functions. Package authors can therefore reuse their existing function documentation while managing the resulting website through Quarto.

The package is particularly useful when documentation needs to be integrated into a larger Quarto project. For example, a project containing both R and Python packages can combine reference pages generated by pkgsite with Python documentation produced by Quartodoc. Quarto’s freeze functionality also allows expensive examples to be rendered locally and their results retained for subsequent site builds. This is useful when examples require access to databases, Spark clusters or other services that might be unavailable in a continuous integration environment.

This is free and open source software.

Key Features

  • Converts compiled Rd documentation files into individual Quarto Markdown (.qmd) reference pages.
  • The write_reference() function generates reference pages and an index in a single operation.
  • Automatically creates an index covering the package’s exported functions.
  • Supports configuration through the pkgsite section of a Quarto project’s _quarto.yml file.
  • Allows the destination directory for generated reference pages to be configured.
  • Organizes functions into manually specified sections using the contents configuration option.
  • Automatically groups related functions using roxygen2 @family tags when custom grouping is absent.
  • Falls back to an alphabetical function index when no other grouping information is available.
  • Provides customizable templates for reference pages and the documentation index.
  • Templates can include additional explanatory text, executable code chunks and page-specific Quarto settings.
  • Supports configuration of how examples marked Not Run in the source documentation are handled.
  • Generated reference pages can be incorporated into a wider Quarto website alongside tutorials and other documentation.
  • Works with Quarto’s publishing workflow for generating static documentation sites.

Website: github.com/edgararuiz/pkgsite
Support:
Developer: Edgar Ruiz
License: MIT License

pkgsite is written in R. Learn R with our recommended free books and free tutorials.


Related Software

R Static Site Generators
BookdownR package to facilitate writing books
rmarkdownCreate dynamic analysis documents combining code, rendered output, and prose
BlogdownPowerful and customizable website output format for R Markdown
QuartoScientific and technical publishing system
workflowrHelps researchers organize analysis projects
pkgdownR package that generates static HTML documentation websites
altdocCreate, render, preview, and deploy documentation websites
sandpaperProvides the user interface for The Carpentries Workbench

Read our verdict in the software roundup.


Best Free and Open Source Software LinuxLinks helps you discover the best free and open source software for Linux. Explore our extensive collection of recommended applications, including alternatives to popular proprietary software.

We also publish software reviews, Linux tutorials, hardware reviews, free programming books and articles covering the wider open source community. Browse our Linux resources to discover more.

Know a useful free and open source Linux application we haven't covered? Suggest a program for inclusion.

Has your software been featured on LinuxLinks? Display one of our Featured on LinuxLinks badges on your website or GitHub README.
Subscribe

Please read our Comment Policy before commenting.

Notify of
guest
0 Comments
Oldest
Newest Most Voted