Merge pull request #5 from junkka/documentation
Documentation
diff --git a/NAMESPACE b/NAMESPACE
index fedcf78..52d1605 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -1,4 +1,4 @@
-# Generated by roxygen2 (4.0.2): do not edit by hand
+# Generated by roxygen2 (4.1.0): do not edit by hand
export(revealjs_presentation)
import(rmarkdown)
diff --git a/R/revealjs_presentation.R b/R/revealjs_presentation.R
index e16e6d3..9a41437 100644
--- a/R/revealjs_presentation.R
+++ b/R/revealjs_presentation.R
@@ -7,10 +7,12 @@
#' @inheritParams rmarkdown::html_document
#'
#' @param center \code{TRUE} to vertically center content on slides
-#' @param theme Visual theme ("default", "simple", sky", "beige", "serif", or
-#' "solarized").
-#' @param transition Slide transition ("default", "cube", "page", "concave",
-#' "zoom", "linear", "fade", or "none")
+#' @param theme Visual theme ("default", "simple", "sky", "beige", "serif",
+#' "solarized", "blood", "moon", "night", "black", "league" or "white").
+#' @param transition Slide transition ("default", "none", "fade", "slide",
+#' "convex", "concave" or "zoom")
+#' @param background_transition Slide background-transition ("default", "none", "fade", "slide",
+#' "convex", "concave" or "zoom")
#' @param template Pandoc template to use for rendering. Pass "default"
#' to use the rmarkdown package default template; pass \code{NULL}
#' to use pandoc's built-in template; pass a path to use a custom template
diff --git a/README.md b/README.md
index a51ea48..cf2ed5b 100644
--- a/README.md
+++ b/README.md
@@ -74,9 +74,11 @@
There are several options that control the appearance of revealjs presentations:
-* `theme` specifies the theme to use for the presentation (available themes are "default", "simple", "sky", "beige", "serif", "dark", or "solarized").
+* `theme` specifies the theme to use for the presentation (available themes are "default", "simple", "sky", "beige", "serif", "solarized", "blood", "moon", "night", "black", "league" or "white").
-* `transition` specifies the visual effect when moving between slides. Available transitions are "default", "cube", "page", "concave", "zoom", "linear", "fade", or "none".
+* `transition` specifies the visual effect when moving between slides. Available transitions are "default", "fade", "slide", "convex", "concave", "zoom" or "none".
+
+* `background_transition` specifies the background transition effect when moving between full page slides. Available transitions are "default", "fade", "slide", "convex", "concave", "zoom" or "none".
* `highlight` specifies the syntax highlighting style. Supported styles include "default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn", and "haddock". Pass null to prevent syntax highlighting.
diff --git a/man/revealjs_presentation.Rd b/man/revealjs_presentation.Rd
index b97422e..b9544fe 100644
--- a/man/revealjs_presentation.Rd
+++ b/man/revealjs_presentation.Rd
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/revealjs_presentation.R
\name{revealjs_presentation}
\alias{revealjs_presentation}
\title{Convert to a reveal.js presentation}
@@ -6,9 +7,10 @@
revealjs_presentation(incremental = FALSE, center = FALSE, fig_width = 8,
fig_height = 6, fig_retina = if (!fig_caption) 2, fig_caption = FALSE,
smart = TRUE, self_contained = TRUE, theme = "default",
- transition = "default", highlight = "default", mathjax = "default",
- template = "default", includes = NULL, keep_md = FALSE,
- lib_dir = NULL, pandoc_args = NULL, ...)
+ transition = "default", background_transition = "default",
+ highlight = "default", mathjax = "default", template = "default",
+ includes = NULL, keep_md = FALSE, lib_dir = NULL, pandoc_args = NULL,
+ ...)
}
\arguments{
\item{incremental}{\code{TRUE} to render slide bullets incrementally. Note
@@ -41,11 +43,14 @@
contained documents MathJax is still loaded externally (this is
necessary because of it's size).}
-\item{theme}{Visual theme ("default", "simple", sky", "beige", "serif", or
-"solarized").}
+\item{theme}{Visual theme ("default", "simple", "sky", "beige", "serif",
+"solarized", "blood", "moon", "night", "black", "league" or "white").}
-\item{transition}{Slide transition ("default", "cube", "page", "concave",
-"zoom", "linear", "fade", or "none")}
+\item{transition}{Slide transition ("default", "none", "fade", "slide",
+"convex", "concave" or "zoom")}
+
+\item{background_transition}{Slide background-transition ("default", "none", "fade", "slide",
+"convex", "concave" or "zoom")}
\item{highlight}{Syntax highlighting style. Supported styles include
"default", "tango", "pygments", "kate", "monochrome", "espresso",