2 title: "Vignette Title"
3 author: "Vignette Author"
5 output: rmarkdown::html_vignette
7 %\VignetteIndexEntry{Vignette Title}
8 %\VignetteEngine{knitr::rmarkdown}
9 %\VignetteEncoding{UTF-8}
12 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. The `html_vignette` format:
14 - Never uses retina figures
15 - Has a smaller default figure size
16 - Uses a custom CSS stylesheet instead of the default Twitter Bootstrap style
20 Note the various macros within the `vignette` section of the metadata block above. These are required in order to instruct R how to build the vignette. Note that you should change the `title` field and the `\VignetteIndexEntry` to match the title of your vignette.
24 The `html_vignette` template includes a basic CSS theme. To override this theme you can specify your own CSS in the document metadata as follows:
27 rmarkdown::html_vignette:
32 The figure sizes have been customised so that you can easily put two images side-by-side.
34 ```{r, fig.show='hold'}
39 You can enable figure captions by `fig_caption: yes` in YAML:
42 rmarkdown::html_vignette:
45 Then you can use the chunk option `fig.cap = "Your figure caption."` in **knitr**.
49 You can write math expressions, e.g. $Y = X\beta + \epsilon$, footnotes^[A footnote here.], and tables, e.g. using `knitr::kable()`.
51 ```{r, echo=FALSE, results='asis'}
52 knitr::kable(head(mtcars, 10))
55 Also a quote using `>`:
57 > "He who gives up [code] safety for [code] speed deserves neither."
58 ([via](https://twitter.com/hadleywickham/status/504368538874703872))