add documentation for slidify.

R/slidify.R

@@ -1,7 +1,10 @@
 #' Convert an Rmd document into HTML5
 #' 
-#' @noRd
-pagify <- slidify <- function(inputFile, knit_deck = TRUE, return_page = FALSE,
+#' @param inputFile path to the Rmd file to slidify
+#' @param knit_deck whether the file needs to be run through knit
+#' @param return_page should the function return the payload
+#' @param save_payload should the payload be saved to the slide directory
+slidify <- pagify <- function(inputFile, knit_deck = TRUE, return_page = FALSE,
     save_payload = FALSE){
   site = ifelse(file.exists('site.yml'), yaml.load_file('site.yml'), list())
   page = parse_page(inputFile, knit_deck)

man/slidify.Rd

@@ -0,0 +1,23 @@
+\name{slidify}
+\alias{slidify}
+\title{Convert an Rmd document into HTML5}
+\usage{
+  slidify(inputFile, knit_deck = TRUE, return_page = FALSE,
+    save_payload = FALSE)
+}
+\arguments{
+  \item{inputFile}{path to the Rmd file to slidify}
+
+  \item{knit_deck}{whether the file needs to be run through
+  knit}
+
+  \item{return_page}{should the function return the
+  payload}
+
+  \item{save_payload}{should the payload be saved to the
+  slide directory}
+}
+\description{
+  Convert an Rmd document into HTML5
+}
+