revealjs_presentation {revealjs} | R Documentation |
Convert to a reveal.js presentation
Description
Format for converting from R Markdown to a reveal.js presentation.
Usage
revealjs_presentation(incremental = FALSE, center = FALSE,
slide_level = 2, fig_width = 8, fig_height = 6, fig_retina = if
(!fig_caption) 2, fig_caption = FALSE, smart = TRUE,
self_contained = TRUE, theme = "simple", transition = "default",
background_transition = "default", reveal_options = NULL,
reveal_plugins = NULL, highlight = "default", mathjax = "default",
template = "default", css = NULL, includes = NULL, keep_md = FALSE,
lib_dir = NULL, pandoc_args = NULL, extra_dependencies = NULL, ...)
Arguments
incremental |
|
center |
|
slide_level |
Level of heading to denote individual slides. If
|
fig_width |
Default width (in inches) for figures |
fig_height |
Default width (in inches) for figures |
fig_retina |
Scaling to perform for retina displays (defaults to 2, which
currently works for all widely used retina displays). Set to |
fig_caption |
|
smart |
Produce typographically correct output, converting straight quotes to curly quotes, — to em-dashes, – to en-dashes, and ... to ellipses. |
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). |
theme |
Visual theme ("simple", "sky", "beige", "serif", "solarized", "blood", "moon", "night", "black", "league" or "white"). |
transition |
Slide transition ("default", "none", "fade", "slide", "convex", "concave" or "zoom") |
background_transition |
Slide background-transition ("default", "none", "fade", "slide", "convex", "concave" or "zoom") |
reveal_options |
Additional options to specify for reveal.js (see https://github.com/hakimel/reveal.js#configuration for details). |
reveal_plugins |
Reveal plugins to include. Available plugins include
"notes", "search", "zoom", "chalkboard", and "menu". Note that
|
highlight |
Syntax highlighting style. Supported styles include
"default", "tango", "pygments", "kate", "monochrome", "espresso",
"zenburn", and "haddock". Pass |
mathjax |
Include mathjax. The "default" option uses an https URL from
the official 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 |
template |
Pandoc template to use for rendering. Pass "default" to use
the rmarkdown package default template; pass |
css |
One or more css files to include |
includes |
Named list of additional content to include within the
document (typically created using the |
keep_md |
Keep the markdown file generated by knitting. |
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
|
pandoc_args |
Additional command line options to pass to pandoc |
extra_dependencies |
Additional function arguments to pass to the base R
Markdown HTML output formatter |
... |
Ignored |
Details
In reveal.js presentations you can use level 1 or level 2 headers for slides. If you use a mix of level 1 and level 2 headers then a two-dimensional layout will be produced, with level 1 headers building horizontally and level 2 headers building vertically.
For additional documentation on using revealjs presentations see https://github.com/rstudio/revealjs.
Value
R Markdown output format to pass to render
Examples
## Not run:
library(rmarkdown)
library(revealjs)
# simple invocation
render("pres.Rmd", revealjs_presentation())
# specify an option for incremental rendering
render("pres.Rmd", revealjs_presentation(incremental = TRUE))
## End(Not run)