altdoc is an R package that helps package authors create, render, preview, and deploy documentation websites without relying on pkgdown.
It offers a lightweight and flexible workflow that can handle straightforward packages as well as larger projects with many exported functions, vignettes, and project files.
This is free and open source software.
Key Features
- Supports documentation sites built with Quarto, Docsify, Docute, and MkDocs.
- Generates reference pages for exported R functions, including evaluated examples.
- Renders Quarto and R Markdown vignettes as part of the site build process.
- Includes common project files such as README, NEWS, changelog, code of conduct, and citation pages.
- Provides commands to preview sites locally and deploy them to GitHub Pages or other platforms.
Website: github.com/etiennebacher/altdoc
Support:
Developer: Etienne Bacher and Vincent Arel-Bundock
License: MIT License
altdoc 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.