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
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.
html_vignette template includes a basic CSS theme. To override this theme you can specify your own CSS in the document metadata as follows:
output: rmarkdown::html_vignette: css: mystyles.css
The figure sizes have been customised so that you can easily put two images side-by-side.
You can enable figure captions by
fig_caption: yes in YAML:
output: rmarkdown::html_vignette: fig_caption: yes
Then you can use the chunk option
fig.cap = "Your figure caption." in knitr.
You can write math expressions, e.g. $Y = X\beta + \epsilon$, footnotes^[A footnote here.], and tables, e.g. using
Also a quote using
"He who gives up [code] safety for [code] speed deserves neither." (via)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.