altdoc

The goal of altdoc is to facilitate the use of documentation generators as alternatives to pkgdown websites (hence the alt in altdoc). For now, it provides helper functions to use docute, docsify, and mkdocs.

Demos

Some of my packages use altdoc to generate documentation:

Other packages don’t use altdoc but you can get the same results:

Installation

You can install the CRAN version:

install.packages("altdoc")

You can also install the development version to have the latest bug fixes:

# install.packages("remotes")
remotes::install_github("etiennebacher/altdoc")

Features

What this package can do:

Experimental feature (feedback needed):

Functions

Main functions:

More

More details on the package and the deployment are available on the website.

Options for each site generator can be found on their own website: