markdownify: Convert text to Markdown

In roxygen2md: 'Roxygen' to 'Markdown'

Description

Converts a character vector from Rd to Markdown.

With scope = "none", no transformations are carried out.

With scope = "simple", the following elements are converted:

• \code{}

• \emph{}

• \bold{} and \strong{}

• \href{}

• \url{}

With scope = "full", the following elements are converted in addition:

• \code{\link{}} and \link{}, with [] options

• \linkS4class{}

Usage

markdownify(text, scope = c("full", "simple", "none"))

Arguments

text	A character vector containing .Rd style annotations.
scope	The scope of transformations: "simple" runs only transformations that shouldn't substantially change the resulting .Rd files, "full" runs all transformations. In larger packages, run "none", double-check and track the changes, and then run "simple" and then "full".

Value

The same vector with .Rd style annotations converted to Markdown style annotations.

Examples

text <- c(
  "Both \\emph{italics} and \\bold{bold} text.",
  paste0("We can also convert code: \\", "code{\\", "link{identity}}.")
)

text
markdownify(text)

roxygen2md documentation built on June 17, 2019, 5:05 p.m.