~hrbrmstr/markdowntemplates

ref: f755a22f69782b3bfc1a94716dc39313d30b1615 markdowntemplates/man/rst_skeleton.Rd -rw-r--r-- 4.1 KiB View raw
f755a22fboB Rudis docs 1 year, 9 months ago
                                                                                
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rst.r
\encoding{UTF-8}
\name{rst_skeleton}
\alias{rst_skeleton}
\title{Restructured text + Skeleton}
\usage{
rst_skeleton(number_sections = FALSE, fig_width = 7, fig_height = 5,
  fig_retina = if (!fig_caption) 2, fig_caption = FALSE, dev = "png",
  toc = FALSE, toc_depth = 3, smart = TRUE, self_contained = TRUE,
  highlight = "default", mathjax = "default", extra_dependencies = NULL,
  css = NULL, includes = NULL, keep_md = FALSE, lib_dir = NULL,
  md_extensions = NULL, pandoc_args = NULL, ...)
}
\arguments{
\item{number_sections}{\code{TRUE} to number section headings}

\item{fig_width}{Default width (in inches) for figures}

\item{fig_height}{Default width (in inches) for figures}

\item{fig_retina}{Scaling to perform for retina displays (defaults to 2, which
currently works for all widely used retina displays). Set to \code{NULL} to
prevent retina scaling. Note that this will always be \code{NULL} when
\code{keep_md} is specified (this is because \code{fig_retina} relies on
outputting HTML directly into the markdown document).}

\item{fig_caption}{\code{TRUE} to render figures with captions}

\item{dev}{Graphics device to use for figure output (defaults to png)}

\item{toc}{\code{TRUE} to include a table of contents in the output}

\item{toc_depth}{Depth of headers to include in table of contents}

\item{smart}{Produce typographically correct output, converting straight
quotes to curly quotes, --- to em-dashes, -- to en-dashes, and ... to
ellipses.}

\item{self_contained}{Produce a standalone HTML file with no external
dependencies, using data: URIs to incorporate the contents of linked
scripts, stylesheets, images, and videos. Note that even for self contained
documents MathJax is still loaded externally (this is necessary because of
it's size).}

\item{highlight}{Syntax highlighting style. Supported styles include
"default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn",
"haddock", and "textmate". Pass \code{NULL} to prevent syntax highlighting.}

\item{mathjax}{Include mathjax. The "default" option uses an https URL from a
MathJax CDN. The "local" option uses a local version of MathJax (which is
copied into the output directory). You can pass an alternate URL or pass
\code{NULL} to exclude MathJax entirely.}

\item{extra_dependencies, ...}{Additional function arguments to pass to the
base R Markdown HTML output formatter}

\item{css}{One or more css files to include}

\item{includes}{Named list of additional content to include within the
document (typically created using the \code{\link{includes}} function).}

\item{keep_md}{Keep the markdown file generated by knitting.}

\item{lib_dir}{Directory to copy dependent HTML libraries (e.g. jquery,
bootstrap, etc.) into. By default this will be the name of the document with
\code{_files} appended to it.}

\item{md_extensions}{Markdown extensions to be added or removed from the
default definition or R Markdown. See the \code{\link{rmarkdown_format}} for
additional details.}

\item{pandoc_args}{Additional command line options to pass to pandoc}
}
\description{
Template for creating an R restructured text (RST) document in Skeleton style
}
\details{
More info on \href{http://docutils.sourceforge.net/docs/ref/rst/introduction.html}{RST}.

Based on the \href{http://getskeleton.com/}{Skeleton CSS framework}.

\if{html}{
\figure{skeleton.png}{options: width="100\%" alt="Figure: skeleton example"}
}

\if{latex}{
\figure{skeleton.pdf}{options: width=10cm}
}
}
\section{YAML Frontmatter}{

The following example shows all possible YAML frontmatter options:
\preformatted{---
title: "INSERT_TITLE_HERE"
author: "AUTHOR"
navlink: "[NAVTITLE](http://NAVLINK/)"
og:
  type: "article"
  title: "opengraph title"
  url: "optional opengraph url"
  image: "optional opengraph image link"
footer:
  - content: '[link1](http://example.com/) • [link2](http://example.com/)<br/>'
  - content: 'Copyright blah blah'
date: "`r Sys.Date()`"
output: markdowntemplates::rst_skeleton
---}
}

\examples{
\dontrun{
rmarkdown::render("source.Rmd", clean=TRUE, quiet=TRUE, output_file="output.html")
}
}