forked from rstudio/rmarkdown
-
Notifications
You must be signed in to change notification settings - Fork 0
/
rmarkdown_format.Rd
45 lines (41 loc) · 1.21 KB
/
rmarkdown_format.Rd
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
43
44
45
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/output_format.R, R/util.R
\name{rmarkdown_format}
\alias{rmarkdown_format}
\alias{from_rmarkdown}
\title{R Markdown input format definition}
\usage{
rmarkdown_format(extensions = NULL)
from_rmarkdown(implicit_figures = TRUE, extensions = NULL)
}
\arguments{
\item{extensions}{Markdown extensions to be added or removed from the
default definition of R Markdown.}
\item{implicit_figures}{Automatically make figures from images (defaults to \code{TRUE}).}
}
\value{
Pandoc markdown format specification
}
\description{
Compose a pandoc markdown input definition for R Markdown
that can be passed as the \code{from} argument of \link{pandoc_options}.
}
\details{
By default R Markdown is defined as all pandoc markdown extensions with
the following tweaks for backward compatibility with the markdown package
(+ features are added, - features are removed):
\tabular{l}{
\code{+autolink_bare_uris} \cr
\code{+tex_math_single_backslash} \cr
}
For more on pandoc markdown see the
\href{http://pandoc.org/README.html}{pandoc online documentation}.
}
\examples{
\dontrun{
rmarkdown_format("-implicit_figures")
}
}
\seealso{
\link{output_format}, \link{pandoc_options}
}