View source: R/html_vignette.R
html_vignette | R Documentation |
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.
html_vignette(
fig_width = 3,
fig_height = 3,
dev = "png",
df_print = "default",
css = NULL,
highlight = "pygments",
keep_md = FALSE,
readme = FALSE,
self_contained = TRUE,
tabset = FALSE,
code_folding = c("none", "show", "hide"),
extra_dependencies = NULL,
pandoc_args = NULL,
...
)
fig_width |
Default width (in inches) for figures |
fig_height |
Default height (in inches) for figures |
dev |
Graphics device to use for figure output (defaults to png) |
df_print |
Method to be used for printing data frames. Valid values
include "default", "kable", "tibble", and "paged". The "default" method
uses a corresponding S3 method of |
css |
One or more css files to include. |
highlight , ... |
Additional arguments passed to
|
keep_md |
Keep the markdown file generated by knitting. |
readme |
Use this vignette as the package README.md file (i.e. render it as README.md to the package root). Note that if there are image files within your vignette you should be sure to add ‘README_files’ to ‘.Rbuildignore’. |
self_contained |
Produce a standalone HTML file with no external dependencies, using data: URIs to incorporate the contents of linked scripts, stylesheets, images, and videos. Note that even for self contained documents MathJax is still loaded externally (this is necessary because of its size). |
tabset |
Opt-in tabbed-sections feature inspired by |
code_folding |
Enable document readers to toggle the display of R code
chunks. Specify |
extra_dependencies |
Extra dependencies as a list of the
|
pandoc_args |
Additional command line options to pass to pandoc |
Compared to html_document()
, it:
never uses retina figures
never uses a theme
has a smaller default figure size
uses a custom css stylesheet
See the online documentation
for additional details on using the html_vignette()
format.
R Markdown output format to pass to render()
You can organize content using tabs by applying the .tabset
class
attribute to headers within a document. This will cause all sub-headers of
the header with the .tabset
attribute to appear within tabs rather
than as standalone sections. For example:
## Quarterly Results {.tabset} ### By Product ### By Region
With html_document()
, you can also specify two additional attributes to
control the appearance and behavior of the tabs. The .tabset-fade
attributes causes the tabs to fade in and out when switching. The
.tabset-pills
attribute causes the visual appearance of the tabs to
be "pill" rather than traditional tabs. For example:
## Quarterly Results {.tabset .tabset-fade .tabset-pills}
If tabbed sections relies on html_dependency_tabset()
, for example by
html_vignette()
, these two attributes are not supported.
Code blocks become foldable by specifying "show" or "hide" to the
code_folding
parameter. The state can be toggled individually on
browsers. The document-wide toggle button is also provided for
html_document
and some of its extensions such as
html_notebook
. Note that this feature applies not only to source
codes of chunks, but also markdown code blocks.
Supported languages are R, Python, Bash, SQL, C++, Stan, and Julia. To
support code blocks with other languages, add foldable
class to them
(i.e., class.source = "foldable"
as a chunk option).
The default initial state of code folding respects the value given to the
code_folding
parameter. To override the behavior individually, add
fold-none
to disable, fold-hide
to initially hide,
fold-show
to initially show.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.