markdownify | R Documentation |
Converts a character vector from Rd to Markdown.
The scope
argument controls the depth of the transformation.
With scope = "none"
, no transformations are carried out.
The only effect is that Markdown is enabled for this package.
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{}
With scope = "unlink"
, only the following elements are translated:
\\link{...}
to ...
With scope = "indent"
, @param
and @return
tags spanning multiple lines
are indented with two spaces.
markdownify(text, scope = c("full", "simple", "unlink", "indent", "none"))
text |
A character vector containing |
scope |
The scope of transformations: |
The same vector with .Rd
style annotations converted to Markdown
style annotations.
text <- c(
"Both \\emph{italics} and \\bold{bold} text.",
paste0("We can also convert code: \\", "code{\\", "link{identity}}.")
)
text
markdownify(text)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.