Package index

Renderers

Functions that generate markdown files from R documentation objects. The rd2markdown is a core function that does the job while documentation_to_markdown is a vectorized wrapper around it.

rd2markdown()

Render a Rd object out to a markdown file

documentation_to_markdown()

Build a list of documentation files rendered out to markdown

Extractors

Functions that extract documentation objects either directly from the .Rd file or from the installed package.

get_rd()

Safely retrieve help documentation objects

Examples

Example help pages for sampling markdown rendering features

rd_sampler

Rd sampler title