starlightr

Overview

Keeping package documentation current means publishing the reference material and examples alongside each version of the code. starlightr builds a documentation site directly from an R package, turning Rd files into MDX reference pages and vignettes into articles, with example outputs embedded alongside the code. A configuration file controls the site, navigation, and reference sections. starlightr can scaffold a complete Starlight site or generate pages for an existing one. It also checks that the configured reference sections match the package's exported functions and supports documentation for multiple package versions.