forked from rstudio/rmarkdown
-
Notifications
You must be signed in to change notification settings - Fork 0
/
includes.Rd
45 lines (38 loc) · 1.19 KB
/
includes.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/includes.R
\name{includes}
\alias{includes}
\alias{includes_to_pandoc_args}
\title{Include content within output}
\usage{
includes(in_header = NULL, before_body = NULL, after_body = NULL)
includes_to_pandoc_args(includes, filter = identity)
}
\arguments{
\item{in_header}{One or more files with content to be included in the
header of the document.}
\item{before_body}{One or more files with content to be included before
the document body.}
\item{after_body}{One or more files with content to be included after the
document body.}
\item{includes}{Includes to convert to pandoc args.}
\item{filter}{Filter to pre-process includes with.}
}
\value{
Includes list or pandoc args
}
\description{
Specify additional content to be included within an output document.
}
\details{
Non-absolute paths for resources referenced from the
\code{in_header}, \code{before_body}, and \code{after_body}
parameters are resolved relative to the directory of the input document.
}
\examples{
\dontrun{
library(rmarkdown)
html_document(includes = includes(before_body = "header.htm"))
pdf_document(includes = includes(after_body = "footer.tex"))
}
}