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:

• altdoc itself (uses Docute)

• conductor (uses Docsify)

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

• firebase by John Coene (uses Mkdocs, theme Material)

• sever by John Coene (uses Mkdocs, theme readthedocs)

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:

• automatically import core files to use docute, docsify, or mkdocs

• automatically generate Changelog and Code of Conduct sections

• automatically create function reference

• link towards your package’s repo

• preview the site in RStudio Viewer pane

Experimental feature (feedback needed):

• automatically import vignettes, render them to Markdown, and add them to the sidebar or navbar. This feature requires rmarkdown version 2.15 or higher. More details in the section “Get started” on the website.

Functions

Main functions:

• use_*() to create the documentation with docute, docsify or mkdocs
• preview() to show the site
• update_docs()

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:

• Docute

• Docsify

• Mkdocs (Material for Mkdocs)