rmarkdown (version 0.3.3)

html_vignette: Convert to an HTML vignette.

Description

A HTML vignette is a lightweight alternative to html_document suitable for inclusion in packages to be released to CRAN. It reduces the size of a basic vignette from 100k to around 10k.

Usage

html_vignette(fig_width = 3, fig_height = 3, css = NULL, ...)

Arguments

fig_width

Default width (in inches) for figures

fig_height

Default width (in inches) for figures

css

One or more css files to include

...

Additional function arguments to pass to the base R Markdown HTML output formatter

Value

• R Markdown output format to pass to render

Details

Compared to html_document, it:

• never uses retina figures
• has a smaller default figure size
• uses a custom css stylesheet