Add html_vignette template

Author: hadley

R/html_vignette.R

@@ -16,19 +16,21 @@
 #' @inheritParams html_document
 #' @return R Markdown output format to pass to \code{\link{render}}
 #' @export
-html_vignette <- function(fig_width = 3.9,
-                          fig_height = 3.5,
+html_vignette <- function(fig_width = 3,
+                          fig_height = 3,
                           css = NULL,
                           mathjax = NULL,
                           ...) {
 
   if (is.null(css)) {
-    css <- system.file("vignette.css", package = "rmarkdown")
+    css <- system.file("rmarkdown", "templates", "html_vignette" ,"resources", 
+      "vignette.css", package = "rmarkdown")
   }
 
   html_document(fig_width = fig_width, 
                 fig_height = fig_height, 
                 fig_retina = FALSE,
+                mathjax = mathjax,
                 css = css, 
                 theme = NULL,
                 highlight = "pygments",

inst/vignette.css …tes/html_vignette/resources/vignette.cssinst/vignette.css renamed to inst/rmarkdown/templates/html_vignette/resources/vignette.css inst/vignette.css renamed to inst/rmarkdown/templates/html_vignette/resources/vignette.css

@@ -0,0 +1,31 @@
+---
+title: "Vignette title"
+output: rmarkdown::html_vignette
+metadata: >
+  \VignetteEngine{knitr::knitr}
+  \VignetteIndexEntry{Vignette title}
+  \usepackage[utf8]{inputenc}
+---
+
+# Introduction
+
+Vignettes are long form documentation commonly included in packages. Because they are part of the distribution of the package, they need to be as compact as possible. The `html_vignette` output type provides a custom style sheet (and tweaks some options) to ensure that the resulting html is as small as possible.
+
+## Metadata
+
+Note that all Rmarkdown vignettes need to include the following code somewhere in the document:
+
+    \VignetteEngine{knitr::knitr}
+    \VignetteIndexEntry{Vignette title}
+    \usepackage[utf8]{inputenc}
+
+(Yes, they look like latex commands, even though this is an Rmarkdown document.) I recommend putting keeping them in the yaml metadata, as in this template.
+
+## Figures
+
+The figure sizes have been customised so that you can easily put two images side-by-side. 
+
+```{r, echo = FALSE}
+plot(1:10)
+plot(10:1)
+```

inst/rmarkdown/templates/html_vignette/skeleton/skeleton.Rmd

@@ -0,0 +1,5 @@
+name: HTML Vignette
+description: >
+  Template for package vignettes. This customises the basic HTML output
+  to take up as little space as possible.
+create_dir: false