1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/pandoc.R
\name{pandoc.verbatim.return}
\alias{pandoc.verbatim.return}
\alias{pandoc.verbatim}
\title{Add verbatim}
\usage{
pandoc.verbatim.return(x, style = c("inline", "indent", "delim"),
attrs = "")
}
\arguments{
\item{x}{character vector}
\item{style}{show code \code{inline} or in a separate (\code{indent}ed or \code{delim}ited) block}
\item{attrs}{(optionally) pass ID, classes and any attribute to the \code{delimited} block}
}
\value{
By default this function outputs (see: \code{cat}) the result. If you would want to catch the result instead, then call the function ending in \code{.return}.
}
\description{
Pandoc's markdown verbatim format (e.g. \code{`FOO`}) is added to character string.
}
\examples{
# different styles/formats
pandoc.verbatim('FOO')
src <- c('FOO', 'indent', 'BAR' )
pandoc.verbatim(src)
pandoc.verbatim.return(src)
pandoc.verbatim(c('FOOO\\nBAR ', ' I do R'), 'indent')
pandoc.verbatim(c('FOOO\\nBAR ', ' I do R'), 'delim')
# add highlighting and HTML/LaTeX ID and classes (even custom attribute)
pandoc.verbatim(c('cat("FOO")', 'mean(bar)'), 'delim', '.R #MyCode custom_var="10"')
}
\references{
John MacFarlane (2012): _Pandoc User's Guide_. \url{http://johnmacfarlane.net/pandoc/README.html}
}
\seealso{
\code{\link{pandoc.emphasis}} \code{\link{pandoc.strikeout}} \code{\link{pandoc.strong}}
}
|